cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic

Class AutorefractionMeasurementsIOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NonImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.ophthalmic.AutorefractionMeasurementsIOD

public class AutorefractionMeasurementsIOD
extends NonImageIOD

The Autorefraction Measurements IOD is used to encode the results of a modality (autorefractor) that automatically determines,without patient input, what a patient's refractive correction should be.

Author:

saloni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTOREFRACTION_MEASUREMENTS_IOD The Constant AUTOREFRACTION_MEASUREMENTS_IOD.

Constructor Summary

Constructors

Constructor and Description
AutorefractionMeasurementsIOD() This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.
AutorefractionMeasurementsIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
AutorefractionMeasurementsIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
AutorefractionMeasurementsIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
AutorefractionMeasurementsIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
AutorefractionMeasurementsIOD(java.lang.String strFileName) Creates AutorefractionMeasurementsIOD IOD from a DICOM file containing AutorefractionMeasurementsIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributes of Module.
AutorefractionMeasurementsModule	getAutorefractionMeasurementsModule() Retrieves pre-initialized instance of Autorefraction Measurements Module.
AutorefractionMeasurementsSeriesModule	getAutorefractionMeasurementsSeriesModule() Retrieves pre-initialized instance of Autorefraction Measurements Series Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralOphthalmicRefractiveMeasurementsModule	getGeneralOphthalmicRefractiveMeasurementsModule() Retrieves pre-initialized instance of General Ophthalmic Refractive Measurements Module.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of General Series Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD according to the Module Table given in The DICOM Standard.

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

getClinicalTrialStudyModule, getClinicalTrialSubjectModule

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

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object

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

Field Detail

AUTOREFRACTION_MEASUREMENTS_IOD

public static final java.lang.String AUTOREFRACTION_MEASUREMENTS_IOD

The Constant AUTOREFRACTION_MEASUREMENTS_IOD.

See Also:

Constant Field Values

Constructor Detail

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD()

This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD(IDataSet objIDataSet_)

This constructor accepts the DataSet from the user in its superclass IOD.

Parameters:

objIDataSet_ - - specifies the data set to be set in the IOD.

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD(ITransferSyntax objITransferSyntax_,
                             IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

AutorefractionMeasurementsIOD

public AutorefractionMeasurementsIOD(java.lang.String strFileName)
                              throws java.io.IOException,
                                     InvalidIODException

Creates AutorefractionMeasurementsIOD IOD from a DICOM file containing AutorefractionMeasurementsIOD DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

java.io.IOException - Exception caused due to wrong I/O operations.

ParseException - signals if some parse exceptions are occurred.

InvalidIODException - signals if some IOD exceptions are occurred.

Method Detail

getPatientModule

public PatientModule getPatientModule()

Retrieves pre-initialized instance of Patient Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PatientModule - instance of PatientModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

Retrieves pre-initialized instance of General Study Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralStudyModule - instance of GeneralStudyModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

Retrieves pre-initialized instance of Patient Study Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PatientStudyModule - instance of PatientStudyModule.

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

Retrieves pre-initialized instance of General Series Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralSeriesModule - instance of GeneralSeriesModule.

getAutorefractionMeasurementsSeriesModule

public AutorefractionMeasurementsSeriesModule getAutorefractionMeasurementsSeriesModule()

Retrieves pre-initialized instance of Autorefraction Measurements Series Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

AutorefractionMeasurementsSeriesModule - instance of AutorefractionMeasurementsSeriesModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of Clinical Trial Series Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

Retrieves pre-initialized instance of General Equipment Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

Retrieves pre-initialized instance of Enhanced General Equipment Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

getGeneralOphthalmicRefractiveMeasurementsModule

public GeneralOphthalmicRefractiveMeasurementsModule getGeneralOphthalmicRefractiveMeasurementsModule()

Retrieves pre-initialized instance of General Ophthalmic Refractive Measurements Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralOphthalmicRefractiveMeasurementsModule - instance of GeneralOphthalmicRefractiveMeasurementsModule.

getAutorefractionMeasurementsModule

public AutorefractionMeasurementsModule getAutorefractionMeasurementsModule()

Retrieves pre-initialized instance of Autorefraction Measurements Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

AutorefractionMeasurementsModule - instance of AutorefractionMeasurementsModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOP Common Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

SOPCommonModule - instance of SOPCommonModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.

Overrides:

validate in class NonImageIOD

Returns:

boolean - status of validation as success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the Name of IOD,Module and corresponding Attributes of Module.

Overrides:

dumpDICOMInfo in class CompositeIOD

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

Checks whether the Module is present in the IOD or not.

Overrides:

isModulePresent in class NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.