cdac.medinfo.sdk.dcm30_04.dicommodel.print

Class BasicPrintImageOverlayBoxIOD

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

public class BasicPrintImageOverlayBoxIOD
extends NormalizedIOD

The Basic Print Image Overlay Box IOD is an abstraction of the presentation of an image overlay in a basic image box. It contains the overlay pixel data to be printed on the image. A single overlay plane is supported. Overlays may be printed on both color and grayscale images. However, printing of the overlay pixels is only supported in black or white.

Field Summary

Fields

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

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

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
BasicPrintImageOverlayBoxIOD() Instantiates a new basic print image overlay box iod.
BasicPrintImageOverlayBoxIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
BasicPrintImageOverlayBoxIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
BasicPrintImageOverlayBoxIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BasicPrintImageOverlayBoxIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
BasicPrintImageOverlayBoxIOD(java.lang.String strFileName) Creates BasicPrintImageOverlayBoxIOD IOD from a DICOM file containing BasicPrintImageOverlayBoxIOD 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.
BasicPrintImageOverlayBoxModule	getBasicPrintImageOverlayBoxModule() Retrieves pre-initialized instance of Basic Print Image Overlay Box Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
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

BASIC_PRINT_IMAGE_OVERLAYBOX_IOD

public static final java.lang.String BASIC_PRINT_IMAGE_OVERLAYBOX_IOD

The Constant BASIC_PRINT_IMAGE_OVERLAYBOX_IOD.

See Also:

Constant Field Values

Constructor Detail

BasicPrintImageOverlayBoxIOD

public BasicPrintImageOverlayBoxIOD()

Instantiates a new basic print image overlay box iod.

BasicPrintImageOverlayBoxIOD

public BasicPrintImageOverlayBoxIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

BasicPrintImageOverlayBoxIOD

public BasicPrintImageOverlayBoxIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

BasicPrintImageOverlayBoxIOD

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

BasicPrintImageOverlayBoxIOD

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

BasicPrintImageOverlayBoxIOD

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

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

getBasicPrintImageOverlayBoxModule

public BasicPrintImageOverlayBoxModule getBasicPrintImageOverlayBoxModule()

Retrieves pre-initialized instance of Basic Print Image Overlay Box 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:

BasicPrintImageOverlayBoxModule - instance of BasicPrintImageOverlayBoxModule.

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.