cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class WaveformModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.WaveformModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class WaveformModule
extends Module

\* This module describes the attributes in Wave Form Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
WaveformModule(IDataSet objIDataSet) Creates Waveform Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
float	getWaveformDataDisplayScale() Retrieves WaveformDataDisplayScale.
short[]	getWaveformDisplayBackgroundCIELabValue() Retrieves the Waveform Display BackgroundCIELab Value.
WaveformPresentationGroupSequence	getWaveformPresentationGroupSequence() This method provides the pre-initialized object of Waveform Presentation Group Sequence.
WaveformSequence	getWaveformSequence() Retrieves pre-initialized object of WaveformSequence.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
void	setWaveformDataDisplayScale(float fWaveformDataDisplayScale) Sets WaveformDataDisplayScale.
void	setWaveformDisplayBackgroundCIELabValue(short[] sArrWaveformDisplayBackgroundCIELabValue) Sets Waveform Display BackgroundCIELab Value.
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

WaveformModule

public WaveformModule(IDataSet objIDataSet)

Creates Waveform 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getWaveformSequence

public WaveformSequence getWaveformSequence()

Retrieves pre-initialized object of WaveformSequence.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

Returns:

WaveformSequence - instance of Referenced Reference Image Sequence.

setWaveformDataDisplayScale

public void setWaveformDataDisplayScale(float fWaveformDataDisplayScale)

Sets WaveformDataDisplayScale. The recommended time-based waveform data display scale in units of mm/s

Parameters:

fWaveformDataDisplayScale - Float value of the WaveformDataDisplayScale

getWaveformDataDisplayScale

public float getWaveformDataDisplayScale()

Retrieves WaveformDataDisplayScale. The recommended time-based waveform data display scale in units of mm/s

Returns:

float - Float value of the WaveformDataDisplayScale

setWaveformDisplayBackgroundCIELabValue

public void setWaveformDisplayBackgroundCIELabValue(short[] sArrWaveformDisplayBackgroundCIELabValue)

Sets Waveform Display BackgroundCIELab Value. A color triplet value recommended for rendering the waveform display background on a color display.

Parameters:

sArrWaveformDisplayBackgroundCIELabValue - short value of Waveform Display BackgroundCIELab Value.

getWaveformDisplayBackgroundCIELabValue

public short[] getWaveformDisplayBackgroundCIELabValue()

Retrieves the Waveform Display BackgroundCIELab Value. A color triplet value recommended for rendering the waveform display background on a color display.

Returns:

short - short value of Waveform Display BackgroundCIELab Value.

getWaveformPresentationGroupSequence

public WaveformPresentationGroupSequence getWaveformPresentationGroupSequence()

This method provides the pre-initialized object of Waveform Presentation Group Sequence.

Returns:

- object of Waveform Presentation Group 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 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