cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PresentationStateShutterModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PresentationStateShutterModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PresentationStateShutterModule
extends Module

\* This module specifies the attributes of Presentation State Shutter Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PresentationStateShutterModule(IDataSet objIDataSet) Instantiates a new PresentationStateShutterModule.

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getShutterPresentationColorCIELabValue() Retrieves ShutterPresentationColorCIELabValue
short	getShutterPresentationValue() Retrieves single gray scale unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the Spatial Registration Series Module specified by DICOM Standard.
void	setShutterPresentationColorCIELabValue(short[] arrShShutterPresentationColorCIELabValue)
void	setShutterPresentationValue(short shShutterPresentationValue) Sets single gray scale unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display.
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

PresentationStateShutterModule

public PresentationStateShutterModule(IDataSet objIDataSet)

Instantiates a new PresentationStateShutterModule.

Parameters:

objIDataSet - the obj i data set

Method Detail

setShutterPresentationValue

public void setShutterPresentationValue(short shShutterPresentationValue)

Sets single gray scale unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display.

Parameters:

shShutterPresentationValue - short value of single grayscale unsigned value used to replace those parts of the imageoccluded by the shutter, when rendered on a monochrome display.

getShutterPresentationValue

public short getShutterPresentationValue()

Retrieves single gray scale unsigned value used to replace those parts of the image occluded by the shutter, when rendered on a monochrome display.

Returns:

short - short value of single gray scale unsigned value used to replace those parts of the imageoccluded by the shutter, when rendered on a monochrome display.

setShutterPresentationColorCIELabValue

public void setShutterPresentationColorCIELabValue(short[] arrShShutterPresentationColorCIELabValue)

getShutterPresentationColorCIELabValue

public short[] getShutterPresentationColorCIELabValue()

Retrieves ShutterPresentationColorCIELabValue

Returns:

short Array - ShutterPresentationColorCIELabValue

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 - status indicating success or failure

Throws:

InvalidModuleException - the invalid module exception

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the Spatial Registration Series Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the Spatial Registration Series Module