cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTIonBeamsSessionRecordModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTIonBeamsSessionRecordModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTIonBeamsSessionRecordModule
extends Module

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTIonBeamsSessionRecordModule(IDataSet objIDataSet) Instantiates a new rT general plan module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getNumberOfFractionsPlanned() Return Number Of Fractions Planned.
java.lang.String	getPrimaryDosimeterUnit() Retrieves PrimaryDosimeterUnit.
java.lang.String	getReferencedFractionGroupNumber() Return Referenced Fraction Group Number.
TreatmentSessionIonBeamSequence	getReferencedVisitSequence() This method provides the pre-initialized object of Treatment Session Ion BeamSequence.
void	setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned) Sets Number Of Fractions Planned.
void	setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit) Sets PrimaryDosimeterUnit.
void	setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber) Sets Referenced Fraction Group Number.
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

RTIonBeamsSessionRecordModule

public RTIonBeamsSessionRecordModule(IDataSet objIDataSet)

Instantiates a new rT general plan 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

setReferencedFractionGroupNumber

public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)

Sets Referenced Fraction Group Number. Identifier of fraction group within referenced RT Ion Plan.

Parameters:

strReferencedFractionGroupNumber - String value of Number Of Copies.

getReferencedFractionGroupNumber

public java.lang.String getReferencedFractionGroupNumber()

Return Referenced Fraction Group Number.

Returns:

String - String value of Referenced Fraction Group Number.

setNumberOfFractionsPlanned

public void setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned)

Sets Number Of Fractions Planned. Identifier of fraction group within referenced RT Ion Plan.

Parameters:

strNumberOfFractionsPlanned - String value of Number Of Copies.

getNumberOfFractionsPlanned

public java.lang.String getNumberOfFractionsPlanned()

Return Number Of Fractions Planned.

Returns:

String - String value of Number Of Fractions Planned.

setPrimaryDosimeterUnit

public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)

Sets PrimaryDosimeterUnit. Measurement unit of the machine dosimeter. Enumerated Values: 1) MU Monitor Units 2 )NP Number of Particles

Parameters:

enumPrimaryDosimeterUnit - the enum approval status

getPrimaryDosimeterUnit

public java.lang.String getPrimaryDosimeterUnit()

Retrieves PrimaryDosimeterUnit.

Returns:

String - String value of PrimaryDosimeterUnit.

getReferencedVisitSequence

public TreatmentSessionIonBeamSequence getReferencedVisitSequence()

This method provides the pre-initialized object of Treatment Session Ion BeamSequence.

Returns:

- object of Treatment Session Ion BeamSequence. 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