cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RTPrescriptionModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RTPrescriptionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RTPrescriptionModule
extends Module

\* This module specifies the attributes of RT Prescription Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTPrescriptionModule(IDataSet objIDataSet) Instantiates a new rT prescription module.

Method Summary

Methods

Modifier and Type	Method and Description
DoseReferenceSequence	getDoseReferenceSequence() Introduces sequence of Dose References.
java.lang.String	getPrescriptionDescription() Retrieves Prescription Description.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setPrescriptionDescription(java.lang.String strPrescriptionDescription) Sets User-defined description of treatment prescription.
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

RTPrescriptionModule

public RTPrescriptionModule(IDataSet objIDataSet)

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

setPrescriptionDescription

public void setPrescriptionDescription(java.lang.String strPrescriptionDescription)

Sets User-defined description of treatment prescription.

Parameters:

strPrescriptionDescription - - String value of Prescription Description.

getPrescriptionDescription

public java.lang.String getPrescriptionDescription()

Retrieves Prescription Description.

Returns:

the prescription description

getDoseReferenceSequence

public DoseReferenceSequence getDoseReferenceSequence()

Introduces sequence of Dose References.

Returns:

- instance of DoseReferenceSequence.

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.