cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MultiFrameModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MultiFrameModule
extends Module

\* This module specifies the Attributes of a Multi-frame pixel data Image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MultiFrameModule(IDataSet objIDataSet) Instantiates a new multi frame module.

Method Summary

Methods

Modifier and Type	Method and Description
ISingleCollection<ITag>	getFrameIncrementPointer() Retrieves the collections of Frame Increment Pointers.
java.lang.String	getNumberOfFrames() Retrieves total number of frames contained within a Multi-frame Image.
java.lang.String	getStereoPairsPresent() Retrieves Stereo Pairs Present.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection) Sets value that is Used to specify multiple values for Frame Increment Pointer.
void	setNumberOfFrames(java.lang.String strNumberOfFrames) Sets the total number of frames contained within a Multi-frame Image is conveyed in the Number of Frames.
void	setStereoPairsPresent(EnumStereoPairsPresent enumStereoPairsPresent) Sets Stereo Pairs Present.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

MultiFrameModule

public MultiFrameModule(IDataSet objIDataSet)

Instantiates a new multi frame module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setNumberOfFrames

public void setNumberOfFrames(java.lang.String strNumberOfFrames)

Sets the total number of frames contained within a Multi-frame Image is conveyed in the Number of Frames.

Parameters:

strNumberOfFrames - - Specifies the number of frames in the image

setFrameIncrementPointer

public void setFrameIncrementPointer(ISingleCollection<ITag> objSingleCollection)

Sets value that is Used to specify multiple values for Frame Increment Pointer.

Parameters:

objSingleCollection - - Collection of Tags (GroupNumber and ElementNumbers)

setStereoPairsPresent

public void setStereoPairsPresent(EnumStereoPairsPresent enumStereoPairsPresent)

Sets Stereo Pairs Present. The multi-frame pixel data consists of left and right stereoscopic pairs. Enumerated Values: 1) YES. 2) NO.

Parameters:

enumStereoPairsPresent - the enum Stereo Pairs Present

getNumberOfFrames

public java.lang.String getNumberOfFrames()

Retrieves total number of frames contained within a Multi-frame Image.

Returns:

String - String value of number of frames.

getFrameIncrementPointer

public ISingleCollection<ITag> getFrameIncrementPointer()

Retrieves the collections of Frame Increment Pointers.

Returns:

ISingleCollection - collection of Tag objects

getStereoPairsPresent

public java.lang.String getStereoPairsPresent()

Retrieves Stereo Pairs Present. The multi-frame pixel data consists of left and right stereoscopic pairs.

Returns:

String - String value of Stereo Pairs Present.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

collection of Tags - returns the collection containing the collection of tags