cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTGeneralTreatmentRecordModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTGeneralTreatmentRecordModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTGeneralTreatmentRecordModule
extends Module

\* This module provides attributes for RT General Treatment 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
RTGeneralTreatmentRecordModule(IDataSet objIDataSet) Instantiates a new rT general treatment record module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getInstanceNumber() Retrieves instance number identifying this particular instance of the object.
ReferencedRTPlanSequence	getReferencedRTPlanSequence() Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.
ReferencedTreatmentRecordSequence	getReferencedTreatmentRecordSequence() Retrieves a sequence which provides reference to a RT Plan SOP Class/Instance pair.
java.lang.String	getTreatmentDate() Retrieves date when current fraction was delivered, or Date last fraction was delivered in case of RT Treatment Summary Record IOD.
java.lang.String	getTreatmentTime() Retrieves time when current fraction was delivered (begun), or Time last fraction was delivered (begun) in case of RT Treatment Summary Record IOD.
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	setTreatmentDate(java.lang.String strTreatmentDate) Sets date when current fraction was delivered, or Date last fraction was delivered in case of RT Treatment Summary Record IOD.
void	setTreatmentTime(java.lang.String strTreatmentTime) Sets time when current fraction was delivered (begun), or Time last fraction was delivered (begun) in case of RT Treatment Summary Record IOD.
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

RTGeneralTreatmentRecordModule

public RTGeneralTreatmentRecordModule(IDataSet objIDataSet)

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

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.

setTreatmentDate

public void setTreatmentDate(java.lang.String strTreatmentDate)

Sets date when current fraction was delivered, or Date last fraction was delivered in case of RT Treatment Summary Record IOD.

Parameters:

strTreatmentDate - - String value of Treatment Date.

getTreatmentDate

public java.lang.String getTreatmentDate()

Retrieves date when current fraction was delivered, or Date last fraction was delivered in case of RT Treatment Summary Record IOD.

Returns:

String - String value of Treatment Date.

setTreatmentTime

public void setTreatmentTime(java.lang.String strTreatmentTime)

Sets time when current fraction was delivered (begun), or Time last fraction was delivered (begun) in case of RT Treatment Summary Record IOD.

Parameters:

strTreatmentTime - the str treatment time

getTreatmentTime

public java.lang.String getTreatmentTime()

Retrieves time when current fraction was delivered (begun), or Time last fraction was delivered (begun) in case of RT Treatment Summary Record IOD.

Returns:

String - String value of Treatment Time.

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.

getReferencedTreatmentRecordSequence

public ReferencedTreatmentRecordSequence getReferencedTreatmentRecordSequence()

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.