cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StereometricSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StereometricSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StereometricSeriesModule
extends Module

Stereometric Series Module specifies the Attributes that describe a Stereometric Series produced by Ophthalmic Photography equipment (OP) imaging Modalities.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StereometricSeriesModule(IDataSet objIDataSet) Instantiates a new stereometric series module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves Modality of Stereometric Series Module.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the Stereometric Series Module specified by DICOM Standard.
void	setModality(EnumModality enumModality) This method is used to set the Modality in Stereometric Series Module The function accepts a String Value as the Modality and creates the DE based on the transfer syntax and populates the DE with right values.
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

StereometricSeriesModule

public StereometricSeriesModule(IDataSet objIDataSet)

Instantiates a new stereometric series module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setModality

public void setModality(EnumModality enumModality)

This method is used to set the Modality in Stereometric Series Module The function accepts a String Value as the Modality 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

Parameters:

enumModality - the enum modality

getModality

public java.lang.String getModality()

Retrieves Modality of Stereometric Series Module.

Returns:

String - String value of Modality.

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:

Boolean - status indicating success or failure

Throws:

InvalidModuleException - the invalid module exception

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the Stereometric Series Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the Stereometric Series Module