cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTIonPlanIOD

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.rt.RTIonPlanIOD

public class RTIonPlanIOD
extends NormalizedIOD

The focus for this Radiotherapy Ion Plan IOD (RT Ion Plan IOD) is to address the requirements for transfer of treatment plans generatedby manual entry, a virtual simulation system, or a treatment planning system before or during a course of Ion therapy treatment.

Author:

saloni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RT_ION_PLAN_IOD

Fields inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
RTIonPlanIOD() Instantiates a new digital intra oral x ray image iod.
RTIonPlanIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTIonPlanIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTIonPlanIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTIonPlanIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTIonPlanIOD(java.lang.String strFileName) Creates XAImageIOD IOD from a DICOM file containing DigitalIntraOralXRay 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 ClinicalTrialSeriesModule.
ClinicalTrialStudyModule	getClinicalTrialStudyModule() This method returns the ClinicalTrialStudyModule with preinitializing it.
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 GeneralEquipmentModule.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of GeneralStudyModule.
PatientModule	getPatientModule() Retrieves pre-initialized instance of PatientModule.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of PatientStudyModule.
RTFractionSchemeModule	getRTFractionSchemeModule() Retrieves pre-initialized instance of RT Fraction Scheme Module.
RTGeneralPlanModule	getRTGeneralPlanModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
RTIonBeamsModule	getRTIonBeamsModule() Retrieves pre-initialized instance of RT Ion Beams Module.
RTIonToleranceTablesModule	getRTIonToleranceTablesModule() Retrieves pre-initialized instance of RT Ion Tolerance Tables 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.
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 Digital XRay IOD according to the Module Table given in The DICOM Standard.

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_ION_PLAN_IOD

public static final java.lang.String RT_ION_PLAN_IOD

See Also:

Constant Field Values

Constructor Detail

RTIonPlanIOD

public RTIonPlanIOD()

Instantiates a new digital intra oral x ray image iod.

RTIonPlanIOD

public RTIonPlanIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTIonPlanIOD

public RTIonPlanIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTIonPlanIOD

public RTIonPlanIOD(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.

RTIonPlanIOD

public RTIonPlanIOD(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 .

RTIonPlanIOD

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

Creates XAImageIOD IOD from a DICOM file containing DigitalIntraOralXRay 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

getPatientModule

public PatientModule getPatientModule()

Retrieves pre-initialized instance of PatientModule. 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.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of ClinicalTrialSeriesModule. 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.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

Retrieves pre-initialized instance of GeneralStudyModule. 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.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

Retrieves pre-initialized instance of PatientStudyModule. 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.

getClinicalTrialStudyModule

public ClinicalTrialStudyModule getClinicalTrialStudyModule()

This method returns the ClinicalTrialStudyModule with preinitializing it.

Returns:

the clinical trial study module

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:

- 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.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

Retrieves pre-initialized instance of GeneralEquipmentModule. 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.

getRTGeneralPlanModule

public RTGeneralPlanModule getRTGeneralPlanModule()

Retrieves pre-initialized instance of GeneralEquipmentModule. 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.

getRTIonToleranceTablesModule

public RTIonToleranceTablesModule getRTIonToleranceTablesModule()

Retrieves pre-initialized instance of RT Ion 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:

RTIonToleranceTablesModule - instance of RTIonToleranceTablesModule.

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:

- 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.

getRTIonBeamsModule

public RTIonBeamsModule getRTIonBeamsModule()

Retrieves pre-initialized instance of RT Ion 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:

RTIonBeamsModule - instance of RTIonBeamsModule.

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.

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.

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:

CommonInstanceReferenceModule - instance of CommonInstanceReferenceModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Digital XRay IOD 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 IOD

Returns:

- function status indicating success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid

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 NormalizedIOD

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 NormalizedIOD

Parameters:

strModuleName - String value of module name

Returns:

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