cdac.medinfo.sdk.dcm30_04.dicommodel.implant

Class GenericImplantTemplateIOD

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

public class GenericImplantTemplateIOD
extends NormalizedIOD

The Generic Implant Template Information Object Definition (IOD) specifies the description of a 2D- and/or 3D-template representing a rigid and passive implant.

Author:

saloni

Field Summary

Fields

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

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

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
GenericImplantTemplateIOD() Instantiates a new Generic Implant Template IOD.
GenericImplantTemplateIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
GenericImplantTemplateIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
GenericImplantTemplateIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
GenericImplantTemplateIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
GenericImplantTemplateIOD(java.lang.String strFileName) Creates GenericImplantTemplateIOD IOD from a DICOM file containing GenericImplantTemplateIOD 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.
GenericImplantTemplate2DDrawingsModule	getGenericImplantTemplate2DDrawingsModule() Returns the GenericImplantTemplate2DDrawingsModule with preinitializing it.
GenericImplantTemplate3DModelsModule	getGenericImplantTemplate3DModelsModule() Returns the GenericImplantTemplate3DModelsModule with preinitializing it.
GenericImplantTemplateDescriptionModule	getGenericImplantTemplateDescriptionModule() Returns the GenericImplantTemplateDescriptionModule with preinitializing it.
GenericImplantTemplateMatingFeaturesModule	getGenericImplantTemplateMatingFeaturesModule() Returns the GenericImplantTemplateMatingFeaturesModule with preinitializing it.
GenericImplantTemplatePlanningLandmarksModule	getGenericImplantTemplatePlanningLandmarksModule() Returns the GenericImplantTemplatePlanningLandmarksModule with preinitializing it.
SOPCommonModule	getSOPCommonModule() Returns the SOPCommonModule with preinitializing it.
SurfaceMeshModule	getSurfaceMeshModule() Returns the SurfaceMeshModule 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

GENERIC_IMPLANT_TEMPLATE_IOD

public static final java.lang.String GENERIC_IMPLANT_TEMPLATE_IOD

The Constant GENERIC_IMPLANT_TEMPLATE_IOD.

See Also:

Constant Field Values

Constructor Detail

GenericImplantTemplateIOD

public GenericImplantTemplateIOD()

Instantiates a new Generic Implant Template IOD.

GenericImplantTemplateIOD

public GenericImplantTemplateIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

GenericImplantTemplateIOD

public GenericImplantTemplateIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

GenericImplantTemplateIOD

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

GenericImplantTemplateIOD

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

GenericImplantTemplateIOD

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

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

getGenericImplantTemplateDescriptionModule

public GenericImplantTemplateDescriptionModule getGenericImplantTemplateDescriptionModule()

Returns the GenericImplantTemplateDescriptionModule with preinitializing it.

Returns:

- instance of GenericImplantTemplateDescriptionModule.

getGenericImplantTemplate2DDrawingsModule

public GenericImplantTemplate2DDrawingsModule getGenericImplantTemplate2DDrawingsModule()

Returns the GenericImplantTemplate2DDrawingsModule with preinitializing it.

Returns:

- instance of GenericImplantTemplate2DDrawingsModule.

getGenericImplantTemplate3DModelsModule

public GenericImplantTemplate3DModelsModule getGenericImplantTemplate3DModelsModule()

Returns the GenericImplantTemplate3DModelsModule with preinitializing it.

Returns:

- instance of GenericImplantTemplate3DModelsModule.

getGenericImplantTemplateMatingFeaturesModule

public GenericImplantTemplateMatingFeaturesModule getGenericImplantTemplateMatingFeaturesModule()

Returns the GenericImplantTemplateMatingFeaturesModule with preinitializing it.

Returns:

- instance of GenericImplantTemplateMatingFeaturesModule.

getGenericImplantTemplatePlanningLandmarksModule

public GenericImplantTemplatePlanningLandmarksModule getGenericImplantTemplatePlanningLandmarksModule()

Returns the GenericImplantTemplatePlanningLandmarksModule with preinitializing it.

Returns:

- instance of GenericImplantTemplatePlanningLandmarksModule.

getSurfaceMeshModule

public SurfaceMeshModule getSurfaceMeshModule()

Returns the SurfaceMeshModule with preinitializing it.

Returns:

- instance of SurfaceMeshModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Returns the SOPCommonModule 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 Attributes 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.