cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class BitmapDisplayShutterModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.BitmapDisplayShutterModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class BitmapDisplayShutterModule
extends Module

\* This module is used for Bitmap Display 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
BitmapDisplayShutterModule(IDataSet objIDataSet) Creates Bitmap Display Shutter Modulee with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
short	getShutterOverlayGroup() Retrieves the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.
short	getShutterPresentationColorCIELabValue() Retrieves the Shutter Presentation Color CIE Lab Value.
short	getShutterPresentationValue() Retrieves the value used to replace those parts of the image occluded by the shutter, in PValues.
java.lang.String[]	getShutterShape() Retrieves Shape of the shutter defined for display.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setShutterOverlayGroup(short shShutterOverlayGroup) Sets the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.
void	setShutterPresentationColorCIELabValue(short sShutterPresentationColorCIELabValue) Sets the Shutter Presentation Color CIE Lab Value.
void	setShutterPresentationValue(short shShutterPresentationValue) Sets the value used to replace those parts of the image occluded by the shutter, in PValues.
void	setShutterShape(EnumShutterShape[] enumShutterShape) Sets Shape of the shutter defined for 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

BitmapDisplayShutterModule

public BitmapDisplayShutterModule(IDataSet objIDataSet)

Creates Bitmap Display Shutter Modulee 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

setShutterShape

public void setShutterShape(EnumShutterShape[] enumShutterShape)

Sets Shape of the shutter defined for display.

Parameters:

enumShutterShape - the enum shutter shape

getShutterShape

public java.lang.String[] getShutterShape()

Retrieves Shape of the shutter defined for display.

Returns:

the shutter shape

setShutterOverlayGroup

public void setShutterOverlayGroup(short shShutterOverlayGroup)

Sets the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.

Parameters:

shShutterOverlayGroup - short value of Shutter Overlay Group.

getShutterOverlayGroup

public short getShutterOverlayGroup()

Retrieves the Group (60xx) of an Overlay stored within the Presentation State IOD that contains the bitmap data.

Returns:

short - short value of Shutter Overlay Group.

setShutterPresentationValue

public void setShutterPresentationValue(short shShutterPresentationValue)

Sets the value used to replace those parts of the image occluded by the shutter, in PValues.

Parameters:

shShutterPresentationValue - short value of Shutter Presentation Value.

getShutterPresentationValue

public short getShutterPresentationValue()

Retrieves the value used to replace those parts of the image occluded by the shutter, in PValues.

Returns:

short - short value of Shutter Presentation Value.

setShutterPresentationColorCIELabValue

public void setShutterPresentationColorCIELabValue(short sShutterPresentationColorCIELabValue)

Sets the Shutter Presentation Color CIE Lab Value. A color triplet value used to replace those parts of the image occluded by the shutter, when rendered on a color display.

Parameters:

sShutterPresentationColorCIELabValue - short value of Shutter Presentation Color CIE Lab Value.

getShutterPresentationColorCIELabValue

public short getShutterPresentationColorCIELabValue()

Retrieves the Shutter Presentation Color CIE Lab Value.

Returns:

short - short value of Shutter Presentation Color CIE Lab Value.

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.