cdac.medinfo.sdk.dcm30_04.dicommodel.sr

Class ImplantationPlanSRDocumentIOD

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

public class ImplantationPlanSRDocumentIOD
extends NonImageIOD

The Implantation Plan SR Document IOD contains the results of a planning process for an individual patient, wherein specific implanttemplates are selected and positioned using images of the patient.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ImplantationPlanSRDocumentIOD() This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.
ImplantationPlanSRDocumentIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
ImplantationPlanSRDocumentIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
ImplantationPlanSRDocumentIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
ImplantationPlanSRDocumentIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
ImplantationPlanSRDocumentIOD(java.lang.String strFileName) Creates ImplantationPlanSRDocumentIOD IOD from a DICOM file containing ImplantationPlanSRDocumentIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment 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.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
SRDocumentContentModule	getSRDocumentContentModule() Retrieves pre-initialized instance of SRDocumentContentModule.
SRDocumentGeneralModule	getSRDocumentGeneralModule() Retrieves pre-initialized instance of SRDocumentGeneralModule.
SRDocumentSeriesModule	getSRDocumentSeriesModule() Retrieves pre-initialized instance of SRDocumentSeriesModule.
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

IMPLANTATION_PLAN_SR_DOCUMENT_IOD

public static final java.lang.String IMPLANTATION_PLAN_SR_DOCUMENT_IOD

The Constant IMPLANTATION_PLAN_SR_DOCUMENT_IOD.

See Also:

Constant Field Values

Constructor Detail

ImplantationPlanSRDocumentIOD

public ImplantationPlanSRDocumentIOD()

This constructor initializes the TransferSyntax, Dictionary Reader and data set in its superclass IOD.

ImplantationPlanSRDocumentIOD

public ImplantationPlanSRDocumentIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

ImplantationPlanSRDocumentIOD

public ImplantationPlanSRDocumentIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

ImplantationPlanSRDocumentIOD

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

ImplantationPlanSRDocumentIOD

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

ImplantationPlanSRDocumentIOD

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

Creates ImplantationPlanSRDocumentIOD IOD from a DICOM file containing ImplantationPlanSRDocumentIOD 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.

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.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

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

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

getSRDocumentSeriesModule

public SRDocumentSeriesModule getSRDocumentSeriesModule()

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

SRDocumentSeriesModule - instance of SRDocumentSeriesModule.

getSRDocumentGeneralModule

public SRDocumentGeneralModule getSRDocumentGeneralModule()

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

SRDocumentGeneralModule - instance of SRDocumentGeneralModule.

getSRDocumentContentModule

public SRDocumentContentModule getSRDocumentContentModule()

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

SRDocumentContentModule - instance of SRDocumentContentModule.

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.

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.

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.