cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class HangingProtocolEnvironmentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.HangingProtocolEnvironmentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class HangingProtocolEnvironmentModule
extends Module

\* This module is used for Hanging Protocol Environment Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HangingProtocolEnvironmentModule(IDataSet objIDataSet) Creates instance of HangingProtocolEnvironmentModule

Method Summary

Methods

Modifier and Type	Method and Description
NominalScreenDefinitionSequence	getNominalScreenDefinitionSequence() Retrieves pre-initialized object of NominalScreenDefinitionSequence
short	getNumberOfScreens() Retrieves Positive integer indicating the number of screens for which this Hanging Protocol is intended.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setNumberOfScreens(short shNumberOfScreens) Sets Positive integer indicating the number of screens for which this Hanging Protocol is intended.
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

HangingProtocolEnvironmentModule

public HangingProtocolEnvironmentModule(IDataSet objIDataSet)

Creates instance of HangingProtocolEnvironmentModule

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

getNominalScreenDefinitionSequence

public NominalScreenDefinitionSequence getNominalScreenDefinitionSequence()

Retrieves pre-initialized object of NominalScreenDefinitionSequence

Returns:

NominalScreenDefinitionSequence - NominalScreenDefinitionSequence

setNumberOfScreens

public void setNumberOfScreens(short shNumberOfScreens)

Sets Positive integer indicating the number of screens for which this Hanging Protocol is intended.

Parameters:

shNumberOfScreens - short value of Number of Screens

getNumberOfScreens

public short getNumberOfScreens()

Retrieves Positive integer indicating the number of screens for which this Hanging Protocol is intended.

Returns:

short - short value of Number of Screens

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