cdac.medinfo.sdk.dcm30_04.dicommodel.rt

Class RTIonMachineVerificationIOD

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

public class RTIonMachineVerificationIOD
extends NonImageIOD

The RT Ion Machine Verification IOD describes the attributes that are required by an external Machine Parameter Verifier(MPV) when performing verification of a ion radiation therapy treatment, prior to delivery.

Author:

saloni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RT_ION_MACHINE_VERIFICATION_INFORMATION_OBJECT_DEFINITION The Constant RT ION MACHINE VERIFICATION IOD.

Constructor Summary

Constructors

Constructor and Description
RTIonMachineVerificationIOD() Instantiates a new RTIonMachineVerificationIOD
RTIonMachineVerificationIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
RTIonMachineVerificationIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
RTIonMachineVerificationIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
RTIonMachineVerificationIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
RTIonMachineVerificationIOD(java.lang.String strFileName) Creates RTIonMachineVerificationIOD IOD from a DICOM file containing RTIonMachineVerificationIOD 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.
RTGeneralMachineVerificationModule	getRTGeneralMachineVerificationModule() Retrieves pre-initialized instance of RTGeneralMachineVerificationModule.
RTIonMachineVerificationModule	getRTIonMachineVerificationModule() Retrieves pre-initialized instance of RTIonMachineVerificationModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOPCommonModule.
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 RTIonMachineVerificationIOD 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_MACHINE_VERIFICATION_INFORMATION_OBJECT_DEFINITION

public static final java.lang.String RT_ION_MACHINE_VERIFICATION_INFORMATION_OBJECT_DEFINITION

The Constant RT ION MACHINE VERIFICATION IOD.

See Also:

Constant Field Values

Constructor Detail

RTIonMachineVerificationIOD

public RTIonMachineVerificationIOD()

Instantiates a new RTIonMachineVerificationIOD

RTIonMachineVerificationIOD

public RTIonMachineVerificationIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

RTIonMachineVerificationIOD

public RTIonMachineVerificationIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

RTIonMachineVerificationIOD

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

RTIonMachineVerificationIOD

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

RTIonMachineVerificationIOD

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

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

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

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

getRTGeneralMachineVerificationModule

public RTGeneralMachineVerificationModule getRTGeneralMachineVerificationModule()

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

RTGeneralMachineVerificationModule - instance of RTGeneralMachineVerificationModule.

getRTIonMachineVerificationModule

public RTIonMachineVerificationModule getRTIonMachineVerificationModule()

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

RTIonMachineVerificationModule - instance of RTIonMachineVerificationModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD RTIonMachineVerificationIOD 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.