cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StudyComponentAcquisitionModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StudyComponentAcquisitionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StudyComponentAcquisitionModule
extends Module

This class specifies the Study Component Acquisition Module attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
StudyComponentAcquisitionModule(IDataSet objIDataSet) Instantiates a new study component acquisition module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves Type of equipment that acquired the data used to create the images in this Study Component.
PerformingPhysicianIdentificationSequence	getPerformingPhysicianIdentificationSequence() This method Returns provides the pre-initialized object of Performing Physician Identification Sequence.
java.lang.String[]	getPerformingPhysicianNames() Retrieves Institution-generated description or classification of the Study (component) performed.
ProcedureCodeSequence	getProcedureCodeSequence() This method Returns provides the pre-initialized object of Procedure Code Sequence.
java.lang.String	getStudyComponentStatusID() Retrieves the state of the Study Component.
java.lang.String	getStudyDescription() Retrieves Institution-generated description or classification of the Study (component) performed.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setModality(EnumModality enumModality) Sets Type of equipment that originally acquired the data used to create the images in this Series.
void	setPerformingPhysicianNames(java.lang.String[] arrStrPerformingPhysicianNames) Sets the performing physician names.
void	setStudyComponentStatusID(EnumStudyComponentStatusID enumStudyComponentStatusID) Identifies the state of the Study Component.
void	setStudyDescription(java.lang.String strStudyDescription) Sets Institution-generated description or classification of the Study performed.
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

StudyComponentAcquisitionModule

public StudyComponentAcquisitionModule(IDataSet objIDataSet)

Instantiates a new study component acquisition module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

setModality

public void setModality(EnumModality enumModality)

Sets Type of equipment that originally acquired the data used to create the images in this Series.

Parameters:

enumModality - Enum value of Modality.

setPerformingPhysicianNames

public void setPerformingPhysicianNames(java.lang.String[] arrStrPerformingPhysicianNames)

Sets the performing physician names.

Parameters:

arrStrPerformingPhysicianNames - Name of the physician(s) administering the Series. This method is used to set the Performing Physicians' Names. The function accepts a String Array Value as the Series Time and creates the DE based on the transfer syntax and populates the DE with right values. This DE is then added to the Module HashMap

setStudyDescription

public void setStudyDescription(java.lang.String strStudyDescription)

Sets Institution-generated description or classification of the Study performed.

Parameters:

strStudyDescription - String value of Study Description.

setStudyComponentStatusID

public void setStudyComponentStatusID(EnumStudyComponentStatusID enumStudyComponentStatusID)

Identifies the state of the Study Component. Enumerated values:CREATED = Instance created but not yet complete, INCOMPLETE = Acquisition not complete, COMPLETED = Acquisition complete, VERIFIED = Acquisition complete and Quality Control review complete, POSTINTERPRET = Instance created or updated after referenced Study Instance status =COMPLETED

Parameters:

enumStudyComponentStatusID - Enum value of Study Component Status ID.

getModality

public java.lang.String getModality()

Retrieves Type of equipment that acquired the data used to create the images in this Study Component.

Returns:

String - String value of Modality.

getPerformingPhysicianNames

public java.lang.String[] getPerformingPhysicianNames()

Retrieves Institution-generated description or classification of the Study (component) performed.

Returns:

String - String value of Performing Physician Names.

getPerformingPhysicianIdentificationSequence

public PerformingPhysicianIdentificationSequence getPerformingPhysicianIdentificationSequence()

This method Returns provides the pre-initialized object of Performing Physician Identification Sequence.

Returns:

objPerformingPhysicianIdentificationSequence - object of Performing Physician Identification Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

getStudyDescription

public java.lang.String getStudyDescription()

Retrieves Institution-generated description or classification of the Study (component) performed.

Returns:

String - String value of Performing Physician Names.

getProcedureCodeSequence

public ProcedureCodeSequence getProcedureCodeSequence()

This method Returns provides the pre-initialized object of Procedure Code Sequence.

Returns:

objProcedureCodeSequence - object of Procedure Code Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

getStudyComponentStatusID

public java.lang.String getStudyComponentStatusID()

Retrieves the state of the Study Component.

Returns:

String - String value of Study Component Status ID.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

vector of Tags - returns the vector containing the collection of tags