cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTGeneralPlanModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTGeneralPlanModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTGeneralPlanModule
extends Module

\* This module contains attributes for RT General Plan Module.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstanceNumber() Retrieves instance number identifying this particular instance of the object.
java.lang.String[]	getOperatorNames() Retrieves the name of operator administering treatment session.
java.lang.String	getPlanIntent() Retrieves time treatment plan was last modified.
ReferencedDoseSequence	getReferencedDoseSequence() Retrieves sequence of related SOP Class/Instance pairs describing related instances of RT Dose (for grids and named/unnamed point doses).
ReferencedRTPlanSequence	getReferencedRTPlanSequence() Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.
ReferencedStructureSetSequence	getReferencedStructureSetSequence() Retrieves sequence of one Class/Instance pair describing instance of RT Structure Set on which the RT Plan is based.
java.lang.String	getRTPlanDate() Retrieves date treatment plan was last modified.
java.lang.String	getRTPlanDescription() Retrieves user-defined Description for treatment plan.
java.lang.String	getRTPlanGeometry() Retrieves whether RT Plan is based on patient or treatment device geometry.
java.lang.String	getRTPlanLabel() Retrieves user-defined label for treatment plan.
java.lang.String	getRTPlanName() Retrieves user-defined Name for treatment plan.
java.lang.String	getRTPlanTime() Retrieves time treatment plan was last modified.
java.lang.String[]	getTreatmentProtocols() Retrieves planned treatment protocols.
java.lang.String[]	getTreatmentSites() Retrieves planned treatment Sites.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets a number that identifies this image.
void	setOperatorNames(java.lang.String[] arrStrOperatorNames) Sets the name of operator administering treatment session.
void	setPlanIntent(EnumPlanIntent enumPlanIntent) Sets intent of this course of treatment.
void	setRTPlanDate(java.lang.String strRTPlanDate) Sets date treatment plan was last modified.
void	setRTPlanDescription(java.lang.String strRTPlanDescription) Sets user-defined Description for treatment plan.
void	setRTPlanGeometry(EnumRTPlanGeometry enumRTPlanGeometry) Sets whether RT Plan is based on patient or treatment device geometry.
void	setRTPlanLabel(java.lang.String strRTPlanLabel) Sets user-defined label for treatment plan.
void	setRTPlanName(java.lang.String strRTPlanName) Sets user-defined Name for treatment plan.
void	setRTPlanTime(java.lang.String strRTPlanTime) Sets time treatment plan was last modified.
void	setTreatmentProtocols(java.lang.String[] arrStrTreatmentProtocols) Sets the planned treatment protocols.
void	setTreatmentSites(java.lang.String[] arrStrTreatmentSites) Sets the planned treatment Sites.
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

RTGeneralPlanModule

public RTGeneralPlanModule(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

setRTPlanLabel

public void setRTPlanLabel(java.lang.String strRTPlanLabel)

Sets user-defined label for treatment plan.

Parameters:

strRTPlanLabel - - String value of RT Plan Label.

getRTPlanLabel

public java.lang.String getRTPlanLabel()

Retrieves user-defined label for treatment plan.

Returns:

- String value of RT Plan Label.

setRTPlanName

public void setRTPlanName(java.lang.String strRTPlanName)

Sets user-defined Name for treatment plan.

Parameters:

strRTPlanName - the str rt plan name

getRTPlanName

public java.lang.String getRTPlanName()

Retrieves user-defined Name for treatment plan.

Returns:

- String value of RT Plan Name.

setRTPlanDescription

public void setRTPlanDescription(java.lang.String strRTPlanDescription)

Sets user-defined Description for treatment plan.

Parameters:

strRTPlanDescription - - String value of RT Plan Description.

getRTPlanDescription

public java.lang.String getRTPlanDescription()

Retrieves user-defined Description for treatment plan.

Returns:

- String value of RT Plan Description.

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets a number that identifies this image.

Parameters:

strInstanceNumber - - String value of Instance Number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves instance number identifying this particular instance of the object.

Returns:

- String value of instance number.

setOperatorNames

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

Sets the name of operator administering treatment session.

Parameters:

arrStrOperatorNames - - String value 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).

setRTPlanDate

public void setRTPlanDate(java.lang.String strRTPlanDate)

Sets date treatment plan was last modified.

Parameters:

strRTPlanDate - - String value of RT Plan Date.

getRTPlanDate

public java.lang.String getRTPlanDate()

Retrieves date treatment plan was last modified.

Returns:

- String value of RT Plan Date.

setRTPlanTime

public void setRTPlanTime(java.lang.String strRTPlanTime)

Sets time treatment plan was last modified.

Parameters:

strRTPlanTime - - String value of RT Plan Time.

getRTPlanTime

public java.lang.String getRTPlanTime()

Retrieves time treatment plan was last modified.

Returns:

- String value of RT Plan Time.

setTreatmentProtocols

public void setTreatmentProtocols(java.lang.String[] arrStrTreatmentProtocols)

Sets the planned treatment protocols.

Parameters:

arrStrTreatmentProtocols - the arr str treatment protocols

getTreatmentProtocols

public java.lang.String[] getTreatmentProtocols()

Retrieves planned treatment protocols.

Returns:

arrStrOperatorNames - String value of Treatment Protocols.

setPlanIntent

public void setPlanIntent(EnumPlanIntent enumPlanIntent)

Sets intent of this course of treatment. Defined Terms: 1) CURATIVE. 2) PALLIATIVE. 3) PROPHYLACTIC. 4) VERIFICATION.

Parameters:

enumPlanIntent - the enum treatment intent

getPlanIntent

public java.lang.String getPlanIntent()

Retrieves time treatment plan was last modified.

Returns:

- String value of Treatment Intent.

setTreatmentSites

public void setTreatmentSites(java.lang.String[] arrStrTreatmentSites)

Sets the planned treatment Sites.

Parameters:

arrStrTreatmentSites - the arr str treatment sites

getTreatmentSites

public java.lang.String[] getTreatmentSites()

Retrieves planned treatment Sites.

Returns:

arrStrOperatorNames - String value of Treatment Sites.

setRTPlanGeometry

public void setRTPlanGeometry(EnumRTPlanGeometry enumRTPlanGeometry)

Sets whether RT Plan is based on patient or treatment device geometry. Defined Terms: 1) PATIENT = RT Structure Set exists, 2) TREATMENT_DEVICE = RT Structure Set does not exist.

Parameters:

enumRTPlanGeometry - the enum rt plan geometry

getRTPlanGeometry

public java.lang.String getRTPlanGeometry()

Retrieves whether RT Plan is based on patient or treatment device geometry.

Returns:

- String value of RT Plan Geometry.

getReferencedStructureSetSequence

public ReferencedStructureSetSequence getReferencedStructureSetSequence()

Retrieves sequence of one Class/Instance pair describing instance of RT Structure Set on which the RT Plan is based.

Returns:

- instance of ReferencedStructureSetSequence.

getReferencedDoseSequence

public ReferencedDoseSequence getReferencedDoseSequence()

Retrieves sequence of related SOP Class/Instance pairs describing related instances of RT Dose (for grids and named/unnamed point doses).

Returns:

- instance of ReferencedDoseSequence.

getReferencedRTPlanSequence

public ReferencedRTPlanSequence getReferencedRTPlanSequence()

Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.

Returns:

- instance of Referenced RT Plan 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.