cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTPlanIOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NonImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.rt.RTPlanIOD

public class RTPlanIOD
extends NonImageIOD

The focus for this Radiotherapy Plan IOD (RT Plan IOD) is to address the requirements for transfer of treatment plans generated by manual entry, a virtual simulation system, or a treatment planning system before or during a course of treatment. Such plans may contain fractionation information, and define external beams and/or brachytherapy application setups. This IOD may also contain audio curve annotations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RT_PLAN_IOD The Constant RT_PLAN_IOD.

Constructor Summary

Constructors

Constructor and Description
RTPlanIOD() Instantiates a new rT plan iod.
RTPlanIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTPlanIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTPlanIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTPlanIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTPlanIOD(java.lang.String strFileName) Creates RTPlanIOD IOD from a DICOM file containing RTPlanIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributs of Module.
ApprovalModule	getApprovalModule() Retrieves pre-initialized instance of Approval Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
FrameOfReferenceModule	getFrameOfReferenceModule() Retrieves pre-initialized instance of Frame Of Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
RTBeamsModule	getRTBeamsModule() Retrieves pre-initialized instance of RT Beams Module.
RTBrachyApplicationSetupsModule	getRTBrachyApplicationSetupsModule() Retrieves pre-initialized instance of RT Brachy Application Setups Module.
RTFractionSchemeModule	getRTFractionSchemeModule() Retrieves pre-initialized instance of RT Fraction Scheme Module.
RTGeneralPlanModule	getRTGeneralPlanModule() Retrieves pre-initialized instance of RT General Plan Module.
RTPatientSetupModule	getRTPatientSetupModule() Retrieves pre-initialized instance of RT Patient Setup Module.
RTPrescriptionModule	getRTPrescriptionModule() Retrieves pre-initialized instance of RT Prescription Module.
RTSeriesModule	getRTSeriesModule() Retrieves pre-initialized instance of RT Series Module.
RTToleranceTablesModule	getRTToleranceTablesModule() Retrieves pre-initialized instance of RT Tolerance Tables Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD RTPlanIOD according to the Module Table given in The DICOM Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

getClinicalTrialStudyModule, getClinicalTrialSubjectModule

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RT_PLAN_IOD

public static final java.lang.String RT_PLAN_IOD

The Constant RT_PLAN_IOD.

See Also:

Constant Field Values

Constructor Detail

RTPlanIOD

public RTPlanIOD()

Instantiates a new rT plan iod.

RTPlanIOD

public RTPlanIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTPlanIOD

public RTPlanIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .

RTPlanIOD

public RTPlanIOD(IDataSet objIDataSet_)

This constructor accepts the DataSet from the user in its superclass IOD.

Parameters:

objIDataSet_ - - specifies the data set to be set in the IOD.

RTPlanIOD

public RTPlanIOD(ITransferSyntax objITransferSyntax_,
         IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

RTPlanIOD

public RTPlanIOD(java.lang.String strFileName)
          throws java.io.IOException,
                 InvalidIODException

Creates RTPlanIOD IOD from a DICOM file containing RTPlanIOD DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

java.io.IOException - Exception caused due to wrong I/O operations.

ParseException - signals if some parse exceptions are occurred.

InvalidIODException - signals if some IOD exceptions are occurred.

Method Detail

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD RTPlanIOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.

Overrides:

validate in class NonImageIOD

Returns:

boolean - status of validation as success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid.

getApprovalModule

public ApprovalModule getApprovalModule()

Retrieves pre-initialized instance of Approval Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

ApprovalModule - instance of ApprovalModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

Retrieves pre-initialized instance of Common Instance Reference Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

- instance of CommonInstanceReferenceModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of Clinical Trial Series Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

Retrieves pre-initialized instance of General Equipment Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

Retrieves pre-initialized instance of General Study Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

GeneralStudyModule - instance of GeneralStudyModule.

getPatientModule

public PatientModule getPatientModule()

Retrieves pre-initialized instance of Patient Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PatientModule - instance of PatientModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

Retrieves pre-initialized instance of Patient Study Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PatientStudyModule - instance of PatientStudyModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOP Common Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

SOPCommonModule - instance of SOPCommonModule.

getRTSeriesModule

public RTSeriesModule getRTSeriesModule()

Retrieves pre-initialized instance of RT Series Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTSeriesModule - instance of RTSeriesModule.

getFrameOfReferenceModule

public FrameOfReferenceModule getFrameOfReferenceModule()

Retrieves pre-initialized instance of Frame Of Reference Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

FrameOfReferenceModule - instance of FrameOfReferenceModule.

getRTGeneralPlanModule

public RTGeneralPlanModule getRTGeneralPlanModule()

Retrieves pre-initialized instance of RT General Plan Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTGeneralPlanModule - instance of RTGeneralPlanModule.

getRTPrescriptionModule

public RTPrescriptionModule getRTPrescriptionModule()

Retrieves pre-initialized instance of RT Prescription Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTPrescriptionModule - instance of RTPrescriptionModule.

getRTToleranceTablesModule

public RTToleranceTablesModule getRTToleranceTablesModule()

Retrieves pre-initialized instance of RT Tolerance Tables Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTToleranceTablesModule - instance of RTToleranceTablesModule.

getRTPatientSetupModule

public RTPatientSetupModule getRTPatientSetupModule()

Retrieves pre-initialized instance of RT Patient Setup Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTPatientSetupModule - instance of RTPatientSetupModule.

getRTFractionSchemeModule

public RTFractionSchemeModule getRTFractionSchemeModule()

Retrieves pre-initialized instance of RT Fraction Scheme Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTFractionSchemeModule - instance of RTFractionSchemeModule.

getRTBeamsModule

public RTBeamsModule getRTBeamsModule()

Retrieves pre-initialized instance of RT Beams Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTBeamsModule - instance of RTBeamsModule.

getRTBrachyApplicationSetupsModule

public RTBrachyApplicationSetupsModule getRTBrachyApplicationSetupsModule()

Retrieves pre-initialized instance of RT Brachy Application Setups Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

RTBrachyApplicationSetupsModule - instance of RTBrachyApplicationSetupsModule.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the Name of IOD,Module and corresponding Attributs of Module.

Overrides:

dumpDICOMInfo in class CompositeIOD

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

Checks whether the Module is present in the IOD or not.

Overrides:

isModulePresent in class NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.