cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OverlayIdentificationModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OverlayIdentificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OverlayIdentificationModule
extends Module

\* This module defines the Attributes relevant to Overlay Identification Module.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
OverlayIdentificationModule(IDataSet objIDataSet) Creates an Overlay Plane Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getOverlayDate() Retrieves date the Overlay was created.
java.lang.String	getOverlayNumber() Retrieves A number that identifies this Overlay.
java.lang.String	getOverlayTime() Retrieves The time the Overlay was created.
ReferencedImageSequence	getReferencedImageSequence() This method Returns provides the pre-initialized object of Referenced Image Sequence return - object of Referenced Image Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to Overlay Identification Module specified by DICOM Standard.
void	setOverlayDate(java.lang.String strOverlayDate) Sets date the Overlay was created.
void	setOverlayNumber(java.lang.String strOverlayNumber) Sets A number that identifies this Overlay.
void	setOverlayTime(java.lang.String strOverlayTime) Sets The time the Overlay was created.
boolean	validateModule() This method checks the DataSet according the rules of the Overlay Identification Module.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

OverlayIdentificationModule

public OverlayIdentificationModule(IDataSet objIDataSet)

Creates an Overlay Plane Module with default initialization.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method checks the DataSet according the rules of the Overlay Identification Module.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - status of validation as success or failure

Throws:

InvalidModuleException - the invalid module exception

setOverlayNumber

public void setOverlayNumber(java.lang.String strOverlayNumber)

Sets A number that identifies this Overlay.

Parameters:

strOverlayNumber - A number that identifies this Overlay.

getOverlayNumber

public java.lang.String getOverlayNumber()

Retrieves A number that identifies this Overlay.

Returns:

String - return the Overlay Number

setOverlayDate

public void setOverlayDate(java.lang.String strOverlayDate)

Sets date the Overlay was created.

Parameters:

strOverlayDate - The date the Overlay was created.

getOverlayDate

public java.lang.String getOverlayDate()

Retrieves date the Overlay was created.

Returns:

String - return the Overlay Date.

setOverlayTime

public void setOverlayTime(java.lang.String strOverlayTime)

Sets The time the Overlay was created.

Parameters:

strOverlayTime - The time the Overlay was created.

getOverlayTime

public java.lang.String getOverlayTime()

Retrieves The time the Overlay was created.

Returns:

String - return the Overlay Time.

getReferencedImageSequence

public ReferencedImageSequence getReferencedImageSequence()

This method Returns provides the pre-initialized object of Referenced Image Sequence return - object of Referenced Image Sequence. If the module contans the sequence object it retruns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence

Returns:

ReferencedImageSequence - the referenced image sequence

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to Overlay Identification Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the Overlay Identification Module