cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTIonBeamsTreatmentRecordIOD

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

public class RTIonBeamsTreatmentRecordIOD
extends NonImageIOD

The Radiotherapy Ion Beams Treatment Record IOD (RT Ion Beams Treatment Record IOD) addresses the requirements for transferof treatment session reports generated by a treatment verification system during a course of Ion beam treatment, with optional cumu-lative summary information. It may also be used for transfer of treatment information during delivery.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributes of Module.
CalculatedDoseReferenceRecordModule	getCalculatedDoseReferenceRecordModule() Retrieves pre-initialized instance of Calculated Dose Reference Record Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Image Pixel Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
MeasuredDoseReferenceRecordModule	getMeasuredDoseReferenceRecordModule() Retrieves pre-initialized instance of Measured Dose Reference Record Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
RTGeneralTreatmentRecordModule	getRTGeneralTreatmentRecordModule() Retrieves pre-initialized instance of RT General Treatment Record Module.
RTIonBeamsSessionRecordModule	getRTIonBeamsSessionRecordModule() Retrieves pre-initialized instance of RT Beams Session Record Module.
RTPatientSetupModule	getRTPatientSetupModule() Retrieves pre-initialized instance of RT Patient Setup Module.
RTSeriesModule	getRTSeriesModule() Retrieves pre-initialized instance of RT Series Module.
RTTreatmentMachineRecordModule	getRTTreatmentMachineRecordModule() Retrieves pre-initialized instance of RT Treatment Machine Record Module.
RTTreatmentSummaryRecordModule	getRTTreatmentSummaryRecordModule() Retrieves pre-initialized instance of RT Treatment Summary Record 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 RTIonBeamsTreatmentRecordIOD 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_ION_BEAMS_TREATMENT_RECORD_IOD

public static final java.lang.String RT_ION_BEAMS_TREATMENT_RECORD_IOD

The Constant INVALID_RT_BEAMS_TREATMENT_RECORD_IOD.

See Also:

Constant Field Values

Constructor Detail

RTIonBeamsTreatmentRecordIOD

public RTIonBeamsTreatmentRecordIOD()

Instantiates a new RTIonBeamsTreatmentRecordIOD

RTIonBeamsTreatmentRecordIOD

public RTIonBeamsTreatmentRecordIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTIonBeamsTreatmentRecordIOD

public RTIonBeamsTreatmentRecordIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTIonBeamsTreatmentRecordIOD

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

RTIonBeamsTreatmentRecordIOD

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

RTIonBeamsTreatmentRecordIOD

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

Creates RTIonBeamsTreatmentRecordIOD IOD from a DICOM file containing RTIonBeamsTreatmentRecordIOD 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 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:

- instance of PatientModule.

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:

- instance of GeneralStudyModule.

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:

- instance of PatientStudyModule.

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:

- instance of ClinicalTrialSeriesModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

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

getCalculatedDoseReferenceRecordModule

public CalculatedDoseReferenceRecordModule getCalculatedDoseReferenceRecordModule()

Retrieves pre-initialized instance of Calculated Dose Reference Record 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 CalculatedDoseReferenceRecordModule.

getMeasuredDoseReferenceRecordModule

public MeasuredDoseReferenceRecordModule getMeasuredDoseReferenceRecordModule()

Retrieves pre-initialized instance of Measured Dose Reference Record 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 MeasuredDoseReferenceRecordModule.

getRTIonBeamsSessionRecordModule

public RTIonBeamsSessionRecordModule getRTIonBeamsSessionRecordModule()

Retrieves pre-initialized instance of RT Beams Session Record 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 RTIonBeamsSessionRecordModule.

getRTGeneralTreatmentRecordModule

public RTGeneralTreatmentRecordModule getRTGeneralTreatmentRecordModule()

Retrieves pre-initialized instance of RT General Treatment Record 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 RTGeneralTreatmentRecordModule.

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.

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.

getRTTreatmentMachineRecordModule

public RTTreatmentMachineRecordModule getRTTreatmentMachineRecordModule()

Retrieves pre-initialized instance of RT Treatment Machine Record 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 RTTreatmentMachineRecordModule.

getRTTreatmentSummaryRecordModule

public RTTreatmentSummaryRecordModule getRTTreatmentSummaryRecordModule()

Retrieves pre-initialized instance of RT Treatment Summary Record 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 RTTreatmentSummaryRecordModule.

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:

- instance of SOPCommonModule.

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:

- instance of GeneralEquipmentModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates RTIonBeamsTreatmentRecordIOD 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:

- function status indicating success or failure.

Throws:

InvalidIODException - the invalid iod exception

dumpDICOMInfo

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

Dumps the Name of IOD,Module and corresponding Attributes 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.