cdac.medinfo.sdk.dcm30_04.dicommodel.genpurposescheduledprocstep

Class GeneralPurposeScheduledProcedureStepIOD

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

public class GeneralPurposeScheduledProcedureStepIOD
extends NormalizedIOD

A "General Purpose Scheduled Procedure Step Information Object Definition" is an abstraction of the information that describes the scheduled activities, conditions and status of a scheduled procedure step. It contains information about the General Purpose Scheduled Procedure Step ( GP-SPS) 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_SCHEDULED_PROCEDURE_STEP_IOD The GeneralPurposeScheduledProcedureStepIOD

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

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
GeneralPurposeScheduledProcedureStepIOD() Instantiates a new general purpose scheduled procedure step iod.
GeneralPurposeScheduledProcedureStepIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
GeneralPurposeScheduledProcedureStepIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
GeneralPurposeScheduledProcedureStepIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
GeneralPurposeScheduledProcedureStepIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
GeneralPurposeScheduledProcedureStepIOD(java.lang.String strFileName) Creates GeneralPurposeScheduledProcedureStepIOD IOD from a DICOM file containing GeneralPurposeScheduledProcedureStepIOD 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.
GeneralPurposeScheduledProcedureStepInformationModule	getGeneralPurposeScheduledProcedureStepInformationModule() Returns the General Purpose Scheduled Procedure Step Information Module with preinitializing it.
GeneralPurposeScheduledProcedureStepRelationshipModule	getGeneralPurposeScheduledProcedureStepRelationshipModule() Returns the General Purpose Scheduled Procedure Step Relationship Module with preinitializing it.
SOPCommonModule	getSOPCommonModule() Returns the SOP Common Module 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_SCHEDULED_PROCEDURE_STEP_IOD

public static final java.lang.String GENERAL_PURPOSE_SCHEDULED_PROCEDURE_STEP_IOD

The GeneralPurposeScheduledProcedureStepIOD

See Also:

Constant Field Values

Constructor Detail

GeneralPurposeScheduledProcedureStepIOD

public GeneralPurposeScheduledProcedureStepIOD()

Instantiates a new general purpose scheduled procedure step iod.

GeneralPurposeScheduledProcedureStepIOD

public GeneralPurposeScheduledProcedureStepIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

GeneralPurposeScheduledProcedureStepIOD

public GeneralPurposeScheduledProcedureStepIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

GeneralPurposeScheduledProcedureStepIOD

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

GeneralPurposeScheduledProcedureStepIOD

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

GeneralPurposeScheduledProcedureStepIOD

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

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

getGeneralPurposeScheduledProcedureStepInformationModule

public GeneralPurposeScheduledProcedureStepInformationModule getGeneralPurposeScheduledProcedureStepInformationModule()

Returns the General Purpose Scheduled Procedure Step Information Module with preinitializing it.

Returns:

- instance of GeneralPurposeScheduledProcedureStepInformationModule.

getGeneralPurposeScheduledProcedureStepRelationshipModule

public GeneralPurposeScheduledProcedureStepRelationshipModule getGeneralPurposeScheduledProcedureStepRelationshipModule()

Returns the General Purpose Scheduled Procedure Step Relationship Module with preinitializing it.

Returns:

- instance of GeneralPurposeScheduledProcedureStepRelationshipModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Returns the SOP Common Module with preinitializing it.

Returns:

- instance of SOPCommonModule.

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.