cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PresentationStateMaskModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PresentationStateMaskModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PresentationStateMaskModule
extends Module

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MaskSubtractionSequence	getMaskSubtractionSequence() Retrieves pre-initialized object of Mask SubtractionSequence.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
java.lang.String	getRecommendedViewingMode() Return the recommended viewing protocol(s).
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	setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode) Sets Specifies the recommended viewing protocol(s).
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

PresentationStateMaskModule

public PresentationStateMaskModule(IDataSet objIDataSet)

Instantiates a new PresentationStateMaskModule.

Parameters:

objIDataSet - the obj i data set

Method Detail

getMaskSubtractionSequence

public MaskSubtractionSequence getMaskSubtractionSequence()

Retrieves pre-initialized object of Mask SubtractionSequence.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:

MaskSubtractionSequence - instance of Mask SubtractionSequence.

setRecommendedViewingMode

public void setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode)

Sets Specifies the recommended viewing protocol(s).

Parameters:

enumRecommendedViewingMode - enum value of RecommendedViewing Mode

getRecommendedViewingMode

public java.lang.String getRecommendedViewingMode()

Return the recommended viewing protocol(s).

Returns:

String - value of RecommendedViewing Mode

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