cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DisplayShutterModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DisplayShutterModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DisplayShutterModule
extends Module

The Display shutter is a geometric mask that may be applied on the image for presentation purposes in order to neutralize the display of any of the pixels located outside of the shutter shape.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DisplayShutterModule(IDataSet objIDataSet) Instantiates a new display shutter module.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayShutterMacro	getDisplayShutterMacro() Get the Instance of Display Shutter Macro.Attributes related to Display Shutter Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
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

DisplayShutterModule

public DisplayShutterModule(IDataSet objIDataSet)

Instantiates a new display shutter module.

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:

- validation status as success or failure

Throws:

InvalidModuleException - - when the module is invalid

getDisplayShutterMacro

public DisplayShutterMacro getDisplayShutterMacro()

Get the Instance of Display Shutter Macro.Attributes related to Display Shutter Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of Display Shutter Macro which the user programmer can populate

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module