cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class PresentationStateModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.PresentationStateModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class PresentationStateModule
extends Module

\* This module contains Attributes that identify and describe a Presentation State.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
PresentationStateModule(IDataSet objIDataSet) Instantiates a new presentation state module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentCreatorsName() Retrieves Name of operator saving the presentation state (such as a technologist or physician).
java.lang.String	getContentDescription() Retrieves description of this presentation.
java.lang.String	getContentLabel() Retrieves a label that is used to identify this presentation.
java.lang.String	getInstanceNumber() Retrieves a number that identifies this presentation.
MaskSubtractionSequence	getMaskSubtractionSequence() Retrieves pre-initialized object of Mask Subtraction 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
java.lang.String	getPresentationCreationDate() Retrieves Date on which this presentation was created.
java.lang.String	getPresentationCreationTime() Retrieves Time on which this presentation was created.
java.lang.String	getRecommendedViewingMode() Retrieves the recommended viewing protocol(s).
ReferencedSeriesSequence	getReferencedSeriesSequence() Retrieves pre-initialized object of Referenced Series 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	getShutterPresentationValue() Retrieves the value used to replace those parts of the image occluded by the shutter, in PValues.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setContentCreatorsName(java.lang.String strContentCreatorsName) Sets Name of operator saving the presentation state (such as a technologist or physician).
void	setContentDescription(java.lang.String strContentDescription) Sets a description of this presentation.
void	setContentLabel(java.lang.String strContentLabel) Sets a label that is used to identify this presentation.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets a number that identifies this presentation (SOP Instance).
void	setPresentationCreationDate(java.lang.String strPresentationCreationDate) Sets Date on which this presentation was created.
void	setPresentationCreationTime(java.lang.String strPresentationCreationTime) Sets Time on which this presentation was created.
void	setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode) Sets the recommended viewing protocol(s).
void	setShutterPresentationValue(short shShutterPresentationValue) Sets the value used to replace those parts of the image occluded by the shutter, in PValues.
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

PresentationStateModule

public PresentationStateModule(IDataSet objIDataSet)

Instantiates a new presentation state 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - If validation of Module fails

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets a number that identifies this presentation (SOP Instance).

Parameters:

strInstanceNumber - String value of number that identifies this presentation

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves a number that identifies this presentation.

Returns:

String - String value of a number that identifies this presentation.

setContentLabel

public void setContentLabel(java.lang.String strContentLabel)

Sets a label that is used to identify this presentation.

Parameters:

strContentLabel - String value of label that is used to identify this presentation.

getContentLabel

public java.lang.String getContentLabel()

Retrieves a label that is used to identify this presentation.

Returns:

String - String value of a label that is used to identify this presentation.

setContentDescription

public void setContentDescription(java.lang.String strContentDescription)

Sets a description of this presentation.

Parameters:

strContentDescription - String value description of this presentation.

getContentDescription

public java.lang.String getContentDescription()

Retrieves description of this presentation.

Returns:

String - String value description of this presentation.

setPresentationCreationDate

public void setPresentationCreationDate(java.lang.String strPresentationCreationDate)

Sets Date on which this presentation was created.

Parameters:

strPresentationCreationDate - String value of Date on which this presentation was created.

getPresentationCreationDate

public java.lang.String getPresentationCreationDate()

Retrieves Date on which this presentation was created.

Returns:

String - String value of Date on which this presentation was created.

setPresentationCreationTime

public void setPresentationCreationTime(java.lang.String strPresentationCreationTime)

Sets Time on which this presentation was created.

Parameters:

strPresentationCreationTime - String value of Time on which this presentation was created.

getPresentationCreationTime

public java.lang.String getPresentationCreationTime()

Retrieves Time on which this presentation was created.

Returns:

String - String value of Time on which this presentation was created.

setContentCreatorsName

public void setContentCreatorsName(java.lang.String strContentCreatorsName)

Sets Name of operator saving the presentation state (such as a technologist or physician).

Parameters:

strContentCreatorsName - String value of Name of operator

getContentCreatorsName

public java.lang.String getContentCreatorsName()

Retrieves Name of operator saving the presentation state (such as a technologist or physician).

Returns:

String - String value of Name of operator

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. This can return two values :- 1. Value of DicomValue 2. No value as null in string.

setRecommendedViewingMode

public void setRecommendedViewingMode(EnumRecommendedViewingMode enumRecommendedViewingMode)

Sets the recommended viewing protocol(s).

Parameters:

enumRecommendedViewingMode - Enum value viewing protocol(s).

getRecommendedViewingMode

public java.lang.String getRecommendedViewingMode()

Retrieves the recommended viewing protocol(s).

Returns:

String - String value of viewing protocol(s).

getReferencedSeriesSequence

public ReferencedSeriesSequence getReferencedSeriesSequence()

Retrieves pre-initialized object of Referenced Series 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:

ReferencedSeriesSequence - instance of Referenced Series Sequence.

getMaskSubtractionSequence

public MaskSubtractionSequence getMaskSubtractionSequence()

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

MaskSubtractionSequence - instance of Mask Subtraction Sequence.

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.