cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTBeamsSessionRecordModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTBeamsSessionRecordModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTBeamsSessionRecordModule
extends Module

\* This module specifies attributes for RT 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
RTBeamsSessionRecordModule(IDataSet objIDataSet) Instantiates a new rT beams session record module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getNumberOfFractionsPlanned() Retrieves total number of treatments (Fractions) planned for current Fraction Group.
java.lang.String[]	getOperatorNames() Retrieves the name of operator administering treatment session.
java.lang.String	getPrimaryDosimeterUnit() Retrieves total number of treatments (Fractions) planned for current Fraction Group.
java.lang.String	getReferencedFractionGroupNumber() Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
TreatmentSessionBeamSequence	getTreatmentSessionBeamSequence() Retrieves sequence of Beams administered during treatment session.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned) Sets total number of treatments (Fractions) planned for current Fraction Group.
void	setOperatorNames(java.lang.String[] arrStrOperatorNames) Sets the name of operator administering treatment session.
void	setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit) Sets total number of treatments (Fractions) planned for current Fraction Group.
void	setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber) Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
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

RTBeamsSessionRecordModule

public RTBeamsSessionRecordModule(IDataSet objIDataSet)

Instantiates a new rT beams session record 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

setOperatorNames

public void setOperatorNames(java.lang.String[] arrStrOperatorNames)

Sets the name of operator administering treatment session.

Parameters:

arrStrOperatorNames - - String array of Name(s) of the operator(s).

getOperatorNames

public java.lang.String[] getOperatorNames()

Retrieves the name of operator administering treatment session.

Returns:

arrStrOperatorNames - String value of Name(s) of the operator(s).

setReferencedFractionGroupNumber

public void setReferencedFractionGroupNumber(java.lang.String strReferencedFractionGroupNumber)

Sets identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).

Parameters:

strReferencedFractionGroupNumber - - String value of Referenced Fraction Group Number.

getReferencedFractionGroupNumber

public java.lang.String getReferencedFractionGroupNumber()

Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).

Returns:

the referenced fraction group number

setNumberOfFractionsPlanned

public void setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned)

Sets total number of treatments (Fractions) planned for current Fraction Group.

Parameters:

strNumberOfFractionsPlanned - - String value of Number of Fractions Planned.

getNumberOfFractionsPlanned

public java.lang.String getNumberOfFractionsPlanned()

Retrieves total number of treatments (Fractions) planned for current Fraction Group.

Returns:

the number of fractions planned

setPrimaryDosimeterUnit

public void setPrimaryDosimeterUnit(EnumPrimaryDosimeterUnit enumPrimaryDosimeterUnit)

Sets total number of treatments (Fractions) planned for current Fraction Group.

Parameters:

enumPrimaryDosimeterUnit - - Enum value of Primary Dosimeter Unit.

getPrimaryDosimeterUnit

public java.lang.String getPrimaryDosimeterUnit()

Retrieves total number of treatments (Fractions) planned for current Fraction Group.

Returns:

the primary dosimeter unit

getTreatmentSessionBeamSequence

public TreatmentSessionBeamSequence getTreatmentSessionBeamSequence()

Retrieves sequence of Beams administered during treatment session.

Returns:

- instance of TreatmentSessionBeamSequence.

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.