cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class StructuredDisplayModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.StructuredDisplayModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class StructuredDisplayModule
extends Module

\* This module specifies the Attributes that describe Structured Display Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StructuredDisplayModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
ContentIdentificationMacro	getContentIdentificationMacro() Get the Instance of Content Identification Macro related to Content Identification 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.
short[]	getEmptyImageBoxCIELabValue() Retrieves EmptyImageBoxCIELabValue
IconImageSequence	getIconImageSequence() Retrieves pre-initialized object of IconImageSequence.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
NominalScreenDefinitionSequence	getNominalScreenDefinitionSequence() Retrieves pre-initialized object of NominalScreenDefinitionSequence.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	getNumberOfScreens() Retrieves number of screens for this Structured Display.
java.lang.String	getPresentationCreationDate() Retrieves Date on which this structured display was created.
short[]	getStructuredDisplayBackgroundCIELabValue() Retrieves StructuredDisplayBackgroundCIELabValue
java.lang.String[]	getTimeOfLastCalibration() Retrieves Time at which this structured display was created.
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	setEmptyImageBoxCIELabValue(short[] arrShEmptyImageBoxCIELabValue)
void	setNumberOfScreens(short shNumberOfScreens) Sets number of screens for this Structured Display.
void	setPresentationCreationDate(java.lang.String strPresentationCreationDate) Sets Date on which this structured display was created.
void	setStructuredDisplayBackgroundCIELabValue(short[] arrShStructuredDisplayBackgroundCIELabValue)
void	setTimeOfLastCalibration(java.lang.String[] strTimeOfLastCalibration) Sets Time at which this structured display was created.
boolean	validateModule() Validates the Module's DataElement according to Dicom Standard.

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

StructuredDisplayModule

public StructuredDisplayModule(IDataSet objIDataSet)

Method Detail

getContentIdentificationMacro

public ContentIdentificationMacro getContentIdentificationMacro()

Get the Instance of Content Identification Macro related to Content Identification 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 Content Identification Macro which the user programmer can populate

setPresentationCreationDate

public void setPresentationCreationDate(java.lang.String strPresentationCreationDate)

Sets Date on which this structured display was created.

Parameters:

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

getPresentationCreationDate

public java.lang.String getPresentationCreationDate()

Retrieves Date on which this structured display was created.

Returns:

String - value of Date on which this structured display was created.

setTimeOfLastCalibration

public void setTimeOfLastCalibration(java.lang.String[] strTimeOfLastCalibration)

Sets Time at which this structured display was created.

Parameters:

strTimeOfLastCalibration - String array of Time at which this structured display was created.

getTimeOfLastCalibration

public java.lang.String[] getTimeOfLastCalibration()

Retrieves Time at which this structured display was created.

Returns:

String - value of Time at which this structured display was created.

setNumberOfScreens

public void setNumberOfScreens(short shNumberOfScreens)

Sets number of screens for this Structured Display.

Parameters:

shNumberOfScreens - short value of number of screens for this Structured Display.

getNumberOfScreens

public short getNumberOfScreens()

Retrieves number of screens for this Structured Display.

Returns:

short - short value of number of screens for this Structured Display.

getNominalScreenDefinitionSequence

public NominalScreenDefinitionSequence getNominalScreenDefinitionSequence()

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

NominalScreenDefinitionSequence - instance of Nominal Screen Definition Sequence.

getIconImageSequence

public IconImageSequence getIconImageSequence()

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

IconImageSequence - instance of Icon Image Sequence.

setStructuredDisplayBackgroundCIELabValue

public void setStructuredDisplayBackgroundCIELabValue(short[] arrShStructuredDisplayBackgroundCIELabValue)

getStructuredDisplayBackgroundCIELabValue

public short[] getStructuredDisplayBackgroundCIELabValue()

Retrieves StructuredDisplayBackgroundCIELabValue

Returns:

short Array - StructuredDisplayBackgroundCIELabValue

setEmptyImageBoxCIELabValue

public void setEmptyImageBoxCIELabValue(short[] arrShEmptyImageBoxCIELabValue)

getEmptyImageBoxCIELabValue

public short[] getEmptyImageBoxCIELabValue()

Retrieves EmptyImageBoxCIELabValue

Returns:

short Array - EmptyImageBoxCIELabValue

validateModule

public boolean validateModule()
                       throws InvalidModuleException

Description copied from interface: IModule

Validates the Module's DataElement according to Dicom Standard.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - shows status as success or failure.

Throws:

InvalidModuleException

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