cdac.medinfo.sdk.dcm30_04.dicommodel.basicfilmbox

Class BasicFilmBoxIOD

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

public class BasicFilmBoxIOD
extends NormalizedIOD

The Basic Film Box Information Object Definition is an abstraction of the presentation of one film of the film session.

Field Summary

Fields

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

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

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
BasicFilmBoxIOD() Instantiates a new basic film box iod.
BasicFilmBoxIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
BasicFilmBoxIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
BasicFilmBoxIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BasicFilmBoxIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
BasicFilmBoxIOD(java.lang.String strFileName) Creates BasicFilmBoxIOD IOD from a DICOM file containing BasicFilmBoxIOD 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.
BasicFilmBoxPresentationModule	getBasicFilmBoxPresentationModule() Returns the BasicFilmSessionPresentationModule with preinitializing it.
BasicFilmBoxRelationshipModule	getBasicFilmBoxRelationshipModule() Returns the BasicFilmSessionRelationshipModule with preinitializing it.
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

BASIC_FILM_BOX_IOD

public static final java.lang.String BASIC_FILM_BOX_IOD

The Constant BASIC_FILM_BOX_IOD.

See Also:

Constant Field Values

Constructor Detail

BasicFilmBoxIOD

public BasicFilmBoxIOD()

Instantiates a new basic film box iod.

BasicFilmBoxIOD

public BasicFilmBoxIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

BasicFilmBoxIOD

public BasicFilmBoxIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

BasicFilmBoxIOD

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

BasicFilmBoxIOD

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

BasicFilmBoxIOD

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

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

getBasicFilmBoxPresentationModule

public BasicFilmBoxPresentationModule getBasicFilmBoxPresentationModule()

Returns the BasicFilmSessionPresentationModule with preinitializing it.

Returns:

instance of BasicFilmBoxPresentationModule.

getBasicFilmBoxRelationshipModule

public BasicFilmBoxRelationshipModule getBasicFilmBoxRelationshipModule()

Returns the BasicFilmSessionRelationshipModule with preinitializing it.

Returns:

instance of BasicFilmBoxRelationshipModule.

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