cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTTreatmentSummaryRecordModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTTreatmentSummaryRecordModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTTreatmentSummaryRecordModule
extends Module

\* This module describes attributes in RT Treatment Summary 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
RTTreatmentSummaryRecordModule(IDataSet objIDataSet) Instantiates a new rT treatment summary record module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCurrentTreatmentStatus() Retrieves status of the Treatment at the time the Treatment Summary was created.
java.lang.String	getFirstTreatmentDate() Retrieves date of delivery of the first treatment.
FractionGroupSummarySequence	getFractionGroupSummarySequence() Return sequence describing current state of planned vs.
java.lang.String	getMostRecentTreatmentDate() Retrieves date of delivery of the most recent administration.
java.lang.String	getTreatmentStatusComment() Retrieves comment on current treatment status.
TreatmentSummaryCalculatedDoseReferenceSequence	getTreatmentSummaryCalculatedDoseReferenceSequence() Return sequence of references to Measured Dose References.
TreatmentSummaryMeasuredDoseReferenceSequence	getTreatmentSummaryMeasuredDoseReferenceSequence() Return sequence of references to Measured Dose References.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCurrentTreatmentStatus(EnumCurrentTreatmentStatus enumCurrentTreatmentStatus) Sets status of the Treatment at the time the Treatment Summary was created.
void	setFirstTreatmentDate(java.lang.String strFirstTreatmentDate) Sets date of delivery of the first treatment.
void	setMostRecentTreatmentDate(java.lang.String strMostRecentTreatmentDate) Sets date of delivery of the most recent administration.
void	setTreatmentStatusComment(java.lang.String strTreatmentStatusComment) Sets comment on current treatment status.
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

RTTreatmentSummaryRecordModule

public RTTreatmentSummaryRecordModule(IDataSet objIDataSet)

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

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setCurrentTreatmentStatus

public void setCurrentTreatmentStatus(EnumCurrentTreatmentStatus enumCurrentTreatmentStatus)

Sets status of the Treatment at the time the Treatment Summary was created. Enumerated Values: 1) NOT_STARTED - Patient has not yet begun treatment. 2) ON_TREATMENT - Patient is currently undergoing treatment. 3) ON_BREAK - Patient is currently not undergoing treatment, but a resumption date is known. 4) SUSPENDED - Patient is currently not undergoing treatment, but resumption of treatment is planned at an unknown date. 5) STOPPED - Patient has stopped treatment without completing the planned course. 6) COMPLETED - Patient completed the planned course of treatment.

Parameters:

enumCurrentTreatmentStatus - - Enum value of Current Treatment Status.

getCurrentTreatmentStatus

public java.lang.String getCurrentTreatmentStatus()

Retrieves status of the Treatment at the time the Treatment Summary was created.

Returns:

String value of Current Treatment Status.

setTreatmentStatusComment

public void setTreatmentStatusComment(java.lang.String strTreatmentStatusComment)

Sets comment on current treatment status.

Parameters:

strTreatmentStatusComment - the str treatment status comment

getTreatmentStatusComment

public java.lang.String getTreatmentStatusComment()

Retrieves comment on current treatment status.

Returns:

String - String value of Current Treatment Status.

setFirstTreatmentDate

public void setFirstTreatmentDate(java.lang.String strFirstTreatmentDate)

Sets date of delivery of the first treatment.

Parameters:

strFirstTreatmentDate - - String value of First Treatment Date.

getFirstTreatmentDate

public java.lang.String getFirstTreatmentDate()

Retrieves date of delivery of the first treatment.

Returns:

String - String value of First Treatment Date.

setMostRecentTreatmentDate

public void setMostRecentTreatmentDate(java.lang.String strMostRecentTreatmentDate)

Sets date of delivery of the most recent administration.

Parameters:

strMostRecentTreatmentDate - - String value of Most Recent Treatment Date.

getMostRecentTreatmentDate

public java.lang.String getMostRecentTreatmentDate()

Retrieves date of delivery of the most recent administration.

Returns:

String - String value of Most Recent Treatment Date.

getFractionGroupSummarySequence

public FractionGroupSummarySequence getFractionGroupSummarySequence()

Return sequence describing current state of planned vs. delivered fraction groups.

Returns:

objFractionGroupSummarySequence - instance of FractionGroupSummarySequence.

getTreatmentSummaryMeasuredDoseReferenceSequence

public TreatmentSummaryMeasuredDoseReferenceSequence getTreatmentSummaryMeasuredDoseReferenceSequence()

Return sequence of references to Measured Dose References.

Returns:

objTreatmentSummaryMeasuredDoseReferenceSequence - instance of TreatmentSummaryMeasuredDoseReferenceSequence.

getTreatmentSummaryCalculatedDoseReferenceSequence

public TreatmentSummaryCalculatedDoseReferenceSequence getTreatmentSummaryCalculatedDoseReferenceSequence()

Return sequence of references to Measured Dose References.

Returns:

objTreatmentSummaryCalculatedDoseReferenceSequence - instance of TreatmentSummaryMeasuredDoseReferenceSequence.

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:

- the customized collection containing the dataelement tags that beling to this module