cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ImageAcquisitionResultsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ImageAcquisitionResultsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ImageAcquisitionResultsModule
extends Module

\* This module describes the attributes in Image Acquisition Results Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImageAcquisitionResultsModule(IDataSet objIDataSet) Creates Image Acquisition Results Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves Type of equipment that originally acquired the data used to create the images associated with this Modality Performed Procedure Step.
PerformedProtocolCodeSequence	getPerformedProtocolCodeSequence() Retrieves pre-initialized object of Performed Protocol 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
PerformedSeriesSequence	getPerformedSeriesSequence() Retrieves pre-initialized object of PerformedSeriesSequence.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
java.lang.String	getStudyID() Return attribute identifies User or equipment generated Study Identifier.
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 associated with this Modality Performed Procedure Step.
void	setStudyID(java.lang.String strStudyID) Sets attribute identifies User or equipment generated Study Identifier.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

ImageAcquisitionResultsModule

public ImageAcquisitionResultsModule(IDataSet objIDataSet)

Creates Image Acquisition Results Module with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

- validation status as success or failure

Throws:

InvalidModuleException - when the module is invalid

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

setModality

public void setModality(EnumModality enumModality)

Sets Type of equipment that originally acquired the data used to create the images associated with this Modality Performed Procedure Step.

Parameters:

enumModality - the enum modality

getModality

public java.lang.String getModality()

Retrieves Type of equipment that originally acquired the data used to create the images associated with this Modality Performed Procedure Step.

Returns:

the modality

setStudyID

public void setStudyID(java.lang.String strStudyID)

Sets attribute identifies User or equipment generated Study Identifier.

Parameters:

strStudyID - - String Study Identifier.

getStudyID

public java.lang.String getStudyID()

Return attribute identifies User or equipment generated Study Identifier.

Returns:

String - String Study Identifier.

getPerformedProtocolCodeSequence

public PerformedProtocolCodeSequence getPerformedProtocolCodeSequence()

Retrieves pre-initialized object of Performed Protocol 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

Returns:

PerformedProtocolCodeSequence - instance of Performed Protocol Code Sequence

getPerformedSeriesSequence

public PerformedSeriesSequence getPerformedSeriesSequence()

Retrieves pre-initialized object of PerformedSeriesSequence.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

Returns:

PerformedSeriesSequence - instance of Performed Series Sequence