cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class VisualFieldStaticPerimetryTestParametersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.VisualFieldStaticPerimetryTestParametersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class VisualFieldStaticPerimetryTestParametersModule
extends Module

\* This module describes attributes related to Visual Field Static Perimetry Test Parameters Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
VisualFieldStaticPerimetryTestParametersModule(IDataSet objIDataSet) Creates Visual Field Static Perimetry Test Parameters Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
BackgroundIlluminationColorCodeSequence	getBackgroundIlluminationColorCodeSequence() This method provides the pre-initialized object of Background Illumination Color Code Sequence.
float	getBackgroundLuminance() Retrieves Background Luminance.
float	getMaximumStimulusLuminance() Retrieves Maximum Stimulus Luminance.
ScreeningTestModeCodeSequence	getScreeningTestModeCodeSequence() This method provides the pre-initialized object of Screening Test Mode Code Sequence.
float	getStimulusArea() Retrieves Stimulus Area.
StimulusColorCodeSequence	getStimulusColorCodeSequence() This method provides the pre-initialized object of Stimulus Color Code Sequence.
float	getStimulusPresentationTime() Retrieves Stimulus Presentation Time.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
float	getVisualFieldHorizontalExtent() Retrieves Visual Field Horizontal Extent.
java.lang.String	getVisualFieldShape() Retrieves Visual Field Shape.
float	getVisualFieldVerticalExtent() Retrieves Visual Field Vertical Extent.
void	setBackgroundLuminance(float fBackgroundLuminance) Sets Background Luminance.
void	setMaximumStimulusLuminance(float fMaximumStimulusLuminance) Sets Maximum Stimulus Luminance.
void	setStimulusArea(float fStimulusArea) Sets Stimulus Area.
void	setStimulusPresentationTime(float fStimulusPresentationTime) Sets Stimulus Presentation Time.
void	setVisualFieldHorizontalExtent(float fVisualFieldHorizontalExtent) Sets Visual Field Horizontal Extent.
void	setVisualFieldShape(EnumVisualFieldShape enumVisualFieldShape) Sets Visual Field Shape.
void	setVisualFieldVerticalExtent(float fVisualFieldVerticalExtent) Sets Visual Field Vertical Extent.
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

VisualFieldStaticPerimetryTestParametersModule

public VisualFieldStaticPerimetryTestParametersModule(IDataSet objIDataSet)

Creates Visual Field Static Perimetry Test Parameters 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

setVisualFieldHorizontalExtent

public void setVisualFieldHorizontalExtent(float fVisualFieldHorizontalExtent)

Sets Visual Field Horizontal Extent. The maximum horizontal angular subtend (diameter or width) of the tested visual field, in degrees.

Parameters:

fVisualFieldHorizontalExtent - Float value of the Visual Field Horizontal Extent

getVisualFieldHorizontalExtent

public float getVisualFieldHorizontalExtent()

Retrieves Visual Field Horizontal Extent. The maximum horizontal angular subtend (diameter or width) of the tested visual field, in degrees.

Returns:

float - Float value of the Visual Field Horizontal Extent

setVisualFieldVerticalExtent

public void setVisualFieldVerticalExtent(float fVisualFieldVerticalExtent)

Sets Visual Field Vertical Extent. The maximum vertical angular subtend (diameter or height) of the tested visual field, in degrees.

Parameters:

fVisualFieldVerticalExtent - Float value of the Visual Field Vertical Extent

getVisualFieldVerticalExtent

public float getVisualFieldVerticalExtent()

Retrieves Visual Field Vertical Extent. The maximum vertical angular subtend (diameter or height) of the tested visual field, in degrees.

Returns:

float - Float value of the Visual Field Vertical Extent

setVisualFieldShape

public void setVisualFieldShape(EnumVisualFieldShape enumVisualFieldShape)

Sets Visual Field Shape. The shape of the visual field tested. Enumerated Values: 1) RECTANGLE 2) CIRCLE 3) ELLIPSE

Parameters:

enumVisualFieldShape - the enum Visual Field Shape

getVisualFieldShape

public java.lang.String getVisualFieldShape()

Retrieves Visual Field Shape. The shape of the visual field tested.

Returns:

String - String value of Visual Field Shape.

getScreeningTestModeCodeSequence

public ScreeningTestModeCodeSequence getScreeningTestModeCodeSequence()

This method provides the pre-initialized object of Screening Test Mode Code Sequence.

Returns:

- object of Screening Test Mode 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

setMaximumStimulusLuminance

public void setMaximumStimulusLuminance(float fMaximumStimulusLuminance)

Sets Maximum Stimulus Luminance. Maximum luminance of stimulus, in candelas per square meter(cd/m²).

Parameters:

fMaximumStimulusLuminance - Float value of the Maximum Stimulus Luminance

getMaximumStimulusLuminance

public float getMaximumStimulusLuminance()

Retrieves Maximum Stimulus Luminance. Maximum luminance of stimulus, in candelas per square meter(cd/m²).

Returns:

float - Float value of the Maximum Stimulus Luminance

setBackgroundLuminance

public void setBackgroundLuminance(float fBackgroundLuminance)

Sets Background Luminance. Background luminance of the device, in candelas per squaremeter (cd/m²).

Parameters:

fBackgroundLuminance - Float value of the Background Luminance

getBackgroundLuminance

public float getBackgroundLuminance()

Retrieves Background Luminance. Background luminance of the device, in candelas per squaremeter (cd/m²).

Returns:

float - Float value of the Background Luminance

getStimulusColorCodeSequence

public StimulusColorCodeSequence getStimulusColorCodeSequence()

This method provides the pre-initialized object of Stimulus Color Code Sequence.

Returns:

- object of Stimulus Color 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

getBackgroundIlluminationColorCodeSequence

public BackgroundIlluminationColorCodeSequence getBackgroundIlluminationColorCodeSequence()

This method provides the pre-initialized object of Background Illumination Color Code Sequence.

Returns:

- object of Background Illumination Color 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

setStimulusArea

public void setStimulusArea(float fStimulusArea)

Sets Stimulus Area. Area of light stimulus presented to the patient, in degrees squared.

Parameters:

fStimulusArea - Float value of the Stimulus Area.

getStimulusArea

public float getStimulusArea()

Retrieves Stimulus Area. Area of light stimulus presented to the patient, in degrees squared.

Returns:

float - Float value of the Stimulus Area.

setStimulusPresentationTime

public void setStimulusPresentationTime(float fStimulusPresentationTime)

Sets Stimulus Presentation Time. The duration of time that a light stimulus is presented to a patient per each individual test point, in milliseconds

Parameters:

fStimulusPresentationTime - Float value of the Stimulus Presentation Time

getStimulusPresentationTime

public float getStimulusPresentationTime()

Retrieves Stimulus Presentation Time. The duration of time that a light stimulus is presented to apatient per each individual test point, in milliseconds

Returns:

float - Float value of the Stimulus Presentation Time

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