cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class GeneralOphthalmicRefractiveMeasurementsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.GeneralOphthalmicRefractiveMeasurementsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class GeneralOphthalmicRefractiveMeasurementsModule
extends Module

\* This module is used for General Ophthalmic Refractive Measurements Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GeneralOphthalmicRefractiveMeasurementsModule(IDataSet objIDataSet) Creates General Ophthalmic Refractive Measurements Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentDate() Retrieves the Content Date.
java.lang.String	getContentTime() Retrieves the Content Time.
java.lang.String	getImageComments() Retrieves User-defined comments about the image.
java.lang.String	getInstanceNumber() Retrieves A number that identifies this film box.
java.lang.String	getMeasurementLaterality() Retrieves Measurement Laterality.
ReferencedRefractiveMeasurementsSequence	getReferencedRefractiveMeasurementsSequence() This method provides the pre-initialized object of Referenced Refractive Measurements Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setContentDate(java.lang.String strContentDate) The method is used to set The date on measurements data creation started.
void	setContentTime(java.lang.String strContentTime) The method is used to set The time at which measurements data creation started.
void	setImageComments(java.lang.String strImageComments) Sets User-defined comments about the image.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets A number that identifies this film box.
void	setMeasurementLaterality(EnumMeasurementLaterality enumMeasurementLaterality) Sets Measurement Laterality.
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

GeneralOphthalmicRefractiveMeasurementsModule

public GeneralOphthalmicRefractiveMeasurementsModule(IDataSet objIDataSet)

Creates General Ophthalmic Refractive Measurements 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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets A number that identifies this film box.

Parameters:

strInstanceNumber - String value of number that identifies this film box.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves A number that identifies this film box.

Returns:

String - String value of A number that identifies this film box.

setContentDate

public void setContentDate(java.lang.String strContentDate)

The method is used to set The date on measurements data creation started.

Parameters:

strContentDate - - String value of Content Date

setContentTime

public void setContentTime(java.lang.String strContentTime)

The method is used to set The time at which measurements data creation started.

Parameters:

strContentTime - - String value of Content Time

getContentDate

public java.lang.String getContentDate()

Retrieves the Content Date.

Returns:

String - the Content Date

getContentTime

public java.lang.String getContentTime()

Retrieves the Content Time.

Returns:

String - the Content Time

setMeasurementLaterality

public void setMeasurementLaterality(EnumMeasurementLaterality enumMeasurementLaterality)

Sets Measurement Laterality. Enumerated Values: 1) R - right 2) L - left 3) B - both left and right together.

Parameters:

enumMeasurementLaterality - the enum Measurement Laterality

getMeasurementLaterality

public java.lang.String getMeasurementLaterality()

Retrieves Measurement Laterality.

Returns:

String - String value of Measurement Laterality.

setImageComments

public void setImageComments(java.lang.String strImageComments)

Sets User-defined comments about the image.

Parameters:

strImageComments - - String value of Image Comments.

getImageComments

public java.lang.String getImageComments()

Retrieves User-defined comments about the image.

Returns:

String - String value of Image Comments.

getReferencedRefractiveMeasurementsSequence

public ReferencedRefractiveMeasurementsSequence getReferencedRefractiveMeasurementsSequence()

This method provides the pre-initialized object of Referenced Refractive Measurements Sequence.

Returns:

- object of Referenced Refractive Measurements 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

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags