cdac.medinfo.sdk.dcm30_04.dicommodel.genpurposeperformedprocstep

Class GeneralPurposePerformedProcedureStepIOD

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

public class GeneralPurposePerformedProcedureStepIOD
extends NormalizedIOD

A "General Purpose Performed Procedure Step Information Object Definition" is an abstraction of the information that describes the activities, conditions and results of a procedure step performed on a performing device. It contains information about the General Purpose Performed Procedure Step (GP-PPS) and its relations to other Information Entities of the DICOM real-world model

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GENERAL_PURPOSE_PERFORMED_PROCEDURE_STEP_IOD The GeneralPurposePerformedProcedureStepIOD

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

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
GeneralPurposePerformedProcedureStepIOD() Instantiates a new general purpose performed procedure step iod.
GeneralPurposePerformedProcedureStepIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
GeneralPurposePerformedProcedureStepIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
GeneralPurposePerformedProcedureStepIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
GeneralPurposePerformedProcedureStepIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
GeneralPurposePerformedProcedureStepIOD(java.lang.String strFileName) Creates GeneralPurposePerformedProcedureStepIOD IOD from a DICOM file containing GeneralPurposePerformedProcedureStepIOD 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.
GeneralPurposePerformedProcedureStepInformationModule	getGeneralPurposePerformedProcedureStepInformationModule() Retrieves pre-initialized instance of General Purpose Performed Procedure Step Information Module.
GeneralPurposePerformedProcedureStepRelationshipModule	getGeneralPurposePerformedProcedureStepRelationshipModule() Retrieves pre-initialized instance of General Purpose Performed Procedure Step Relationship Module.
GeneralPurposeResultsModule	getGeneralPurposeResultsModule() Retrieves pre-initialized instance of General Purpose Results Module.
SOPCommonModule	getSOPCommonModule() Returns the SOPCommonModule with preinitializing it.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates 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

GENERAL_PURPOSE_PERFORMED_PROCEDURE_STEP_IOD

public static final java.lang.String GENERAL_PURPOSE_PERFORMED_PROCEDURE_STEP_IOD

The GeneralPurposePerformedProcedureStepIOD

See Also:

Constant Field Values

Constructor Detail

GeneralPurposePerformedProcedureStepIOD

public GeneralPurposePerformedProcedureStepIOD()

Instantiates a new general purpose performed procedure step iod.

GeneralPurposePerformedProcedureStepIOD

public GeneralPurposePerformedProcedureStepIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

GeneralPurposePerformedProcedureStepIOD

public GeneralPurposePerformedProcedureStepIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

GeneralPurposePerformedProcedureStepIOD

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

GeneralPurposePerformedProcedureStepIOD

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

GeneralPurposePerformedProcedureStepIOD

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

Creates GeneralPurposePerformedProcedureStepIOD IOD from a DICOM file containing GeneralPurposePerformedProcedureStepIOD 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()

Returns the SOPCommonModule with preinitializing it.

Returns:

- instance of SOPCommonModule.

getGeneralPurposePerformedProcedureStepRelationshipModule

public GeneralPurposePerformedProcedureStepRelationshipModule getGeneralPurposePerformedProcedureStepRelationshipModule()

Retrieves pre-initialized instance of General Purpose Performed Procedure Step Relationship 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:

GeneralPurposePerformedProcedureStepRelationshipModule - instance of GeneralPurposePerformedProcedureStepRelationshipModule.

getGeneralPurposePerformedProcedureStepInformationModule

public GeneralPurposePerformedProcedureStepInformationModule getGeneralPurposePerformedProcedureStepInformationModule()

Retrieves pre-initialized instance of General Purpose Performed Procedure Step Information 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:

GeneralPurposePerformedProcedureStepInformationModule - instance of GeneralPurposePerformedProcedureStepInformationModule.

getGeneralPurposeResultsModule

public GeneralPurposeResultsModule getGeneralPurposeResultsModule()

Retrieves pre-initialized instance of General Purpose Results 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:

GeneralPurposeResultsModule - instance of GeneralPurposeResultsModule.

validate

public boolean validate()
                 throws InvalidIODException

Description copied from class: IOD

This method validates IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the modules are present but are invalid because both the modules in IOD are user optional modules

Overrides:

validate in class IOD

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