cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTBrachySessionRecordModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTBrachySessionRecordModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTBrachySessionRecordModule
extends Module

\* This module describes the attributes in RT Brachy 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
RTBrachySessionRecordModule(IDataSet objIDataSet) Creates RT Brachy Session Record Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBrachyTreatmentTechnique() Retrieves brachytherapy treatment technique.
java.lang.String	getBrachyTreatmentType() Retrieves brachytherapy treatment type.
java.lang.String	getNumberOfFractionsPlanned() Retrieves total number of treatments (Fractions) planned for current Fraction Group.
java.lang.String[]	getOperatorNames() Retrieves Operator Names.
RecordedSourceSequence	getRecordedSourceSequence() Retrieves pre-initialized object of Recorded Source 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
java.lang.String	getReferencedFractionGroupNumber() Retrieves identifier of Fraction Group within RT Plan referenced in Referenced RT Plan Sequence (300C,0002).
TreatmentSessionApplicationSetupSequence	getTreatmentSessionApplicationSetupSequence() Retrieves pre-initialized object of Treatment Session Application Setup Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setBrachyTreatmentTechnique(EnumBrachyTreatmentTechnique enumBrachyTreatmentTechnique) Sets type of brachytherapy treatment technique.
void	setBrachyTreatmentType(EnumBrachyTreatmentType enumBrachyTreatmentType) Sets type of brachytherapy treatment.
void	setNumberOfFractionsPlanned(java.lang.String strNumberOfFractionsPlanned) Sets total number of treatments (Fractions) planned for current Fraction Group.
void	setOperatorNames(java.lang.String[] arrStrOperatorNames) This method is used to set the Operator Names administering treatment session.
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

RTBrachySessionRecordModule

public RTBrachySessionRecordModule(IDataSet objIDataSet)

Creates RT Brachy Session Record Module with default initialization.

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)

This method is used to set the Operator Names administering treatment session.

Parameters:

arrStrOperatorNames - Name of operator administering treatment session.

getOperatorNames

public java.lang.String[] getOperatorNames()

Retrieves Operator Names.

Returns:

String[] - String array of OperatorNames.

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

setBrachyTreatmentTechnique

public void setBrachyTreatmentTechnique(EnumBrachyTreatmentTechnique enumBrachyTreatmentTechnique)

Sets type of brachytherapy treatment technique. Enumerated Values: INTRALUMENARY, INTRACAVITARY, INTERSTITIAL, CONTACT,INTRAVASCULAR, PERMANENT.

Parameters:

enumBrachyTreatmentTechnique - Enum value of Brachy Treatment Technique.

getBrachyTreatmentTechnique

public java.lang.String getBrachyTreatmentTechnique()

Retrieves brachytherapy treatment technique.

Returns:

the brachy treatment technique

setBrachyTreatmentType

public void setBrachyTreatmentType(EnumBrachyTreatmentType enumBrachyTreatmentType)

Sets type of brachytherapy treatment. Defined Terms: MANUAL = manually positioned, HDR = High dose rate, MDR = Medium dose rate, LDR = Low dose rate, PDR = Pulsed dose rate.

Parameters:

enumBrachyTreatmentType - Enum value of Brachy Treatment Type.

getBrachyTreatmentType

public java.lang.String getBrachyTreatmentType()

Retrieves brachytherapy treatment type.

Returns:

the brachy treatment type

getRecordedSourceSequence

public RecordedSourceSequence getRecordedSourceSequence()

Retrieves pre-initialized object of Recorded Source 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

Returns:

RecordedSourceSequence - instance of Recorded Source Sequence.

getTreatmentSessionApplicationSetupSequence

public TreatmentSessionApplicationSetupSequence getTreatmentSessionApplicationSetupSequence()

Retrieves pre-initialized object of Treatment Session Application Setup 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

Returns:

TreatmentSessionApplicationSetupSequence - instance of Treatment Session Application Setup Sequence.

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