cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTIonBeamsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTIonBeamsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTIonBeamsModule
extends Module

\* This module specifies the attributes of RT Ion Beams Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTIonBeamsModule(IDataSet objIDataSet) Instantiates a new patient Orientation module.

Method Summary

Methods

Modifier and Type	Method and Description
IonBeamSequence	getIonBeamSequence() This method provides the pre-initialized object of Ion Beam Sequence.
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, getVectorOfKeys, 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

RTIonBeamsModule

public RTIonBeamsModule(IDataSet objIDataSet)

Instantiates a new patient Orientation 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 - status indicating success or failure

Throws:

InvalidModuleException - - throws exception indicating exaxct cause of failed validation

getIonBeamSequence

public IonBeamSequence getIonBeamSequence()

This method provides the pre-initialized object of Ion Beam Sequence.

Returns:

- object of Ion Beam 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