cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class VisualAcuityMeasurementsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.VisualAcuityMeasurementsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class VisualAcuityMeasurementsModule
extends Module

\* This module describes attributes related to Visual Acuity 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
VisualAcuityMeasurementsModule(IDataSet objIDataSet) Creates Clinical Trial Series Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBackgroundColor() Retrieves Background Color.
java.lang.String	getOptotype() Retrieves Optotype.
java.lang.String	getOptotypeDetailedDefinition() Retrieves Optotype Detailed Definition.
java.lang.String	getOptotypePresentation() Retrieves Optotype Presentation.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
java.lang.String	getViewingDistanceType() Retrieves Viewing Distance Type.
VisualAcuityBothEyesOpenSequence	getVisualAcuityBothEyesOpenSequence() This method provides the pre-initialized object of Visual Acuity Both Eyes Open Sequence.
VisualAcuityLeftEyeSequence	getVisualAcuityLeftEyeSequence() This method provides the pre-initialized object of Visual Acuity Left Eye Sequence.
VisualAcuityRightEyeSequence	getVisualAcuityRightEyeSequence() This method provides the pre-initialized object of Visual Acuity Right Eye Sequence.
VisualAcuityTypeCodeSequence	getVisualAcuityTypeCodeSequence() This method provides the pre-initialized object of Visual Acuity Type Code Sequence.
void	setBackgroundColor(EnumBackgroundColor enumBackgroundColor) Sets Background Color.
void	setOptotype(EnumOptotype enumOptotype) Sets Optotype.
void	setOptotypeDetailedDefinition(java.lang.String strOptotypeDetailedDefinition) Sets Optotype Detailed Definition.
void	setOptotypePresentation(EnumOptotypePresentation enumOptotypePresentation) Sets Optotype Presentation.
void	setViewingDistanceType(EnumViewingDistanceType enumViewingDistanceType) Sets Viewing Distance Type.
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

VisualAcuityMeasurementsModule

public VisualAcuityMeasurementsModule(IDataSet objIDataSet)

Creates Clinical Trial Series 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

setViewingDistanceType

public void setViewingDistanceType(EnumViewingDistanceType enumViewingDistanceType)

Sets Viewing Distance Type. The viewing distance conditions under which a patient's vision was measured. Enumerated Values: 1) DISTANCE 2) NEAR 3) INTERMEDIATE 4) OTHER

Parameters:

enumViewingDistanceType - the enum Viewing Distance Type

getViewingDistanceType

public java.lang.String getViewingDistanceType()

Retrieves Viewing Distance Type.

Returns:

String - String value of Viewing Distance Type.

getVisualAcuityTypeCodeSequence

public VisualAcuityTypeCodeSequence getVisualAcuityTypeCodeSequence()

This method provides the pre-initialized object of Visual Acuity Type Code Sequence.

Returns:

- object of Visual Acuity Type 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

setBackgroundColor

public void setBackgroundColor(EnumBackgroundColor enumBackgroundColor)

Sets Background Color. The color of the background upon which optotypes are displayed for measurements of visual acuity. Enumerated Values: 1) RED 2) GREEN 3) WHITE 4) REDGREENSPLIT

Parameters:

enumBackgroundColor - the enum Background Color

getBackgroundColor

public java.lang.String getBackgroundColor()

Retrieves Background Color.

Returns:

String - String value of Background Color.

setOptotype

public void setOptotype(EnumOptotype enumOptotype)

Sets Optotype. The standardized test type (standard object of regard) used inmeasurements of visual acuity. Enumerated Values: 1) LETTERS 2) NUMBERS 3) PICTURES 4) TUMBLING E 5) LANDOLT C

Parameters:

enumOptotype - the enum Optotype

getOptotype

public java.lang.String getOptotype()

Retrieves Optotype.

Returns:

String - String value of Optotype.

setOptotypeDetailedDefinition

public void setOptotypeDetailedDefinition(java.lang.String strOptotypeDetailedDefinition)

Sets Optotype Detailed Definition.

Parameters:

strOptotypeDetailedDefinition - String value of Optotype Detailed Definition.

getOptotypeDetailedDefinition

public java.lang.String getOptotypeDetailedDefinition()

Retrieves Optotype Detailed Definition.

Returns:

String - String value of Optotype Detailed Definition.

setOptotypePresentation

public void setOptotypePresentation(EnumOptotypePresentation enumOptotypePresentation)

Sets Optotype Presentation. Specifies whether single or multiple optotypes were presented. Enumerated Values: 1) SINGLE 2) MULTIPLE

Parameters:

enumOptotypePresentation - the enum Optotype Presentation

getOptotypePresentation

public java.lang.String getOptotypePresentation()

Retrieves Optotype Presentation.

Returns:

String - String value of Optotype Presentation.

getVisualAcuityRightEyeSequence

public VisualAcuityRightEyeSequence getVisualAcuityRightEyeSequence()

This method provides the pre-initialized object of Visual Acuity Right Eye Sequence.

Returns:

- object of Visual Acuity Right Eye 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

getVisualAcuityLeftEyeSequence

public VisualAcuityLeftEyeSequence getVisualAcuityLeftEyeSequence()

This method provides the pre-initialized object of Visual Acuity Left Eye Sequence.

Returns:

- object of Visual Acuity Left Eye 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

getVisualAcuityBothEyesOpenSequence

public VisualAcuityBothEyesOpenSequence getVisualAcuityBothEyesOpenSequence()

This method provides the pre-initialized object of Visual Acuity Both Eyes Open Sequence.

Returns:

- object of Visual Acuity Both Eyes Open 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