cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTTreatmentSummaryRecordIOD

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

public class RTTreatmentSummaryRecordIOD
extends NonImageIOD

The focus for this Radiotherapy Treatment Summary Record IOD (RT Treatment Summary Record IOD) is to address the requirements for transfer of cumulative summary information, normally generated at the completion of a course of treatment.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RTTreatmentSummaryRecordIOD() This constructor initializes the TransferSyntax and dictionary reader in its superclass IOD.
RTTreatmentSummaryRecordIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTTreatmentSummaryRecordIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTTreatmentSummaryRecordIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTTreatmentSummaryRecordIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTTreatmentSummaryRecordIOD(java.lang.String strFileName) Creates RTTreatmentSummaryRecordIOD IOD from a DICOM file containing RTTreatmentSummaryRecordIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
static java.lang.String	getINVALID_RT_TREATMENT_SUMMARY_RECORD_IOD() Gets the iNVALI d_ r t_ treatmen t_ summar y_ recor d_ iod.
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.
RTSeriesModule	getRTSeriesModule() Retrieves pre-initialized instance of RT Series 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 Non-Image IOD 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_TREATMENT_SUMMARY_RECORD_IOD

public static final java.lang.String RT_TREATMENT_SUMMARY_RECORD_IOD

The Constant RT_TREATMENT_SUMMARY_RECORD_IOD.

See Also:

Constant Field Values

Constructor Detail

RTTreatmentSummaryRecordIOD

public RTTreatmentSummaryRecordIOD()

This constructor initializes the TransferSyntax and dictionary reader in its superclass IOD.

RTTreatmentSummaryRecordIOD

public RTTreatmentSummaryRecordIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTTreatmentSummaryRecordIOD

public RTTreatmentSummaryRecordIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTTreatmentSummaryRecordIOD

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

RTTreatmentSummaryRecordIOD

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

RTTreatmentSummaryRecordIOD

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

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

PatientModule - 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:

GeneralStudyModule - 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:

PatientStudyModule - instance of PatientStudyModule.

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.

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.

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:

RTGeneralTreatmentRecordModule - instance of RTGeneralTreatmentRecordModule.

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:

RTTreatmentSummaryRecordModule - 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:

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 Non-Image 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 NonImageIOD

Returns:

boolean - status of validation as success or failure

Throws:

InvalidIODException - - throws when the IOD is invalid.

getINVALID_RT_TREATMENT_SUMMARY_RECORD_IOD

public static java.lang.String getINVALID_RT_TREATMENT_SUMMARY_RECORD_IOD()

Gets the iNVALI d_ r t_ treatmen t_ summar y_ recor d_ iod.

Returns:

the iNVALI d_ r t_ treatmen t_ summar y_ recor d_ iod

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.