cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OphthalmicPhotographyAcquisitionParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OphthalmicPhotographyAcquisitionParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OphthalmicPhotographyAcquisitionParametersModule
extends Module

\* This module specifies the Attributes that describe an Ophthalmic Photography Acquisition Parameters Module \* This module describes patient clinical conditions related to the image acquisition.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OphthalmicPhotographyAcquisitionParametersModule(IDataSet objIDataSet) Instantiates a new ophthalmic photography acquisition parameters module.

Method Summary

Methods

Modifier and Type	Method and Description
OphthalmicAcquisitionParametersMacro	getOphthalmicAcquisitionParametersMacro() Get the Instance of Ophthalmic Acquisition Parameters Macro.Attributes related to OphthalmicAcquisitionParameters Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
PatientEyeMovementCommandCodeSequence	getPatientEyeMovementCommandCodeSequence() This method Returns provides the pre-initialized object of Patient Eye Movement Command Code Sequence return - object of Patient Eye Movement Command Code Sequence.
java.lang.String	getPatientEyeMovementCommanded() Retrieves the value of Patient Eye Movement Commanded.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setPatientEyeMovementCommanded(EnumPatientEyeMovementCommanded enumPatientEyeMovementCommanded) Sets the value of Patient Eye Movement Commanded.
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

OphthalmicPhotographyAcquisitionParametersModule

public OphthalmicPhotographyAcquisitionParametersModule(IDataSet objIDataSet)

Instantiates a new ophthalmic photography acquisition parameters module.

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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getOphthalmicAcquisitionParametersMacro

public OphthalmicAcquisitionParametersMacro getOphthalmicAcquisitionParametersMacro()

Get the Instance of Ophthalmic Acquisition Parameters Macro.Attributes related to OphthalmicAcquisitionParameters Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Ophthalmic Acquisition Parameters Macro which the user programmer can populate

setPatientEyeMovementCommanded

public void setPatientEyeMovementCommanded(EnumPatientEyeMovementCommanded enumPatientEyeMovementCommanded)

Sets the value of Patient Eye Movement Commanded.

Parameters:

enumPatientEyeMovementCommanded - - Enum of value of Patient Eye Movement Commanded

getPatientEyeMovementCommanded

public java.lang.String getPatientEyeMovementCommanded()

Retrieves the value of Patient Eye Movement Commanded.

Returns:

the patient eye movement commanded

getPatientEyeMovementCommandCodeSequence

public PatientEyeMovementCommandCodeSequence getPatientEyeMovementCommandCodeSequence()

This method Returns provides the pre-initialized object of Patient Eye Movement Command Code Sequence return - object of Patient Eye Movement Command Code Sequence. If the module contans 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:

SourceImageSequence - the Patient Eye Movement Command Code Sequence

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