cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTBrachyApplicationSetupsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTBrachyApplicationSetupsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTBrachyApplicationSetupsModule
extends Module

The RT Brachy Application Setups Module describes the application of a brachytherapy radiotherapy treatment.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTBrachyApplicationSetupsModule(IDataSet objIDataSet) Instantiates a new rT brachy application setups module.

Method Summary

Methods

Modifier and Type	Method and Description
ApplicationSetupSequence	getApplicationSetupSequence() Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.
java.lang.String	getBrachyTreatmentTechnique() Retrieves brachytherapy treatment technique.
java.lang.String	getBrachyTreatmentType() Retrieves brachytherapy treatment type.
SourceSequence	getSourceSequence() Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.
TreatmentMachineSequence	getTreatmentMachineSequence() Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.
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..
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

RTBrachyApplicationSetupsModule

public RTBrachyApplicationSetupsModule(IDataSet objIDataSet)

Instantiates a new rT brachy application setups 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

setBrachyTreatmentTechnique

public void setBrachyTreatmentTechnique(EnumBrachyTreatmentTechnique enumBrachyTreatmentTechnique)

Sets type of brachytherapy treatment technique.

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..

Parameters:

enumBrachyTreatmentType - - Enum value of Brachy Treatment Type.

getBrachyTreatmentType

public java.lang.String getBrachyTreatmentType()

Retrieves brachytherapy treatment type.

Returns:

the brachy treatment type

getTreatmentMachineSequence

public TreatmentMachineSequence getTreatmentMachineSequence()

Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.

Returns:

- instance of TreatmentMachineSequence.

getSourceSequence

public SourceSequence getSourceSequence()

Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.

Returns:

- instance of SourceSequence.

getApplicationSetupSequence

public ApplicationSetupSequence getApplicationSetupSequence()

Retrieves sequence of items describing Frames of Reference in which the ROIs are defined.

Returns:

- instance of ApplicationSetupSequence.

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