cdac.medinfo.sdk.dcm30_04.baselibs

Class LuminanceResultMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.LuminanceResultMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class LuminanceResultMacro
extends Macro

This macro records the result of a Luminance QA task for a Display Subsystem.

Author:

saloni

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LuminanceResultMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
LuminanceResultMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
LuminanceResultMacro(IItem objItem) This constructor constructs a Macro with the specified Item
LuminanceResultMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and DictionaryReader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAmbientLightValueSource() Return Ambient Light Value Source
LuminanceResponseSequence	getLuminanceResponseSequence() Retrieves pre-initialized object of Luminance Response 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.
short	getNumberOfLuminancePoints() Retrieves number of luminance measurements recorded.
short	getReflectedAmbientLight() Retrieves Reflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.
void	setAmbientLightValueSource(EnumSetupDeviceType enumAmbientLightValueSource) Sets the source of the ambient light value.
void	setNumberOfLuminancePoints(short shNumberOfLuminancePoints) Sets number of luminance measurements recorded.
void	setReflectedAmbientLight(short shReflectedAmbientLight) Sets Reflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.
boolean	validate() Validates all the attributes in LuminanceResultMacro
static boolean	validate(IDataSet objIDataSet) Validates all the attributes in LuminanceResultMacro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in LuminanceResultMacro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

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

Constructor Detail

LuminanceResultMacro

public LuminanceResultMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of DataElements

LuminanceResultMacro

public LuminanceResultMacro(IDataSet objDataSet,
                    IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

LuminanceResultMacro

public LuminanceResultMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

LuminanceResultMacro

public LuminanceResultMacro(IItem objItem,
                    IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and DictionaryReader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in LuminanceResultMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IDataSet objIDataSet)
                        throws InvalidMacroException

Validates all the attributes in LuminanceResultMacro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in LuminanceResultMacro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

setNumberOfLuminancePoints

public void setNumberOfLuminancePoints(short shNumberOfLuminancePoints)

Sets number of luminance measurements recorded.

Parameters:

shNumberOfLuminancePoints - short value of number of luminance measurements recorded.

getNumberOfLuminancePoints

public short getNumberOfLuminancePoints()

Retrieves number of luminance measurements recorded.

Returns:

short - short value of number of luminance measurements recorded.

getLuminanceResponseSequence

public LuminanceResponseSequence getLuminanceResponseSequence()

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

Returns:

LuminanceResponseSequence - instance of LuminanceResponseSequence.

setReflectedAmbientLight

public void setReflectedAmbientLight(short shReflectedAmbientLight)

Sets Reflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.

Parameters:

shReflectedAmbientLight - short value of Reflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.

getReflectedAmbientLight

public short getReflectedAmbientLight()

Retrieves Reflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.

Returns:

short - short value ofReflected ambient light in candelas per square meter (cd/m2) when themeasurements were taken.

setAmbientLightValueSource

public void setAmbientLightValueSource(EnumSetupDeviceType enumAmbientLightValueSource)

Sets the source of the ambient light value. Enumerated Values: DEFAULT :a configured default value was used. MEASURED:the value was measured at the time of the other measurements. PROVIDED:the value was provided by an external source.

Parameters:

enumAmbientLightValueSource - enum value of Ambient Light Value Source

getAmbientLightValueSource

public java.lang.String getAmbientLightValueSource()

Return Ambient Light Value Source

Returns:

String - value of AmbientLightValueSource