cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class FramePointersModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FramePointersModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class FramePointersModule
extends Module

\* The class FramePointersModule.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FramePointersModule(IDataSet objIDataSet) Instantiates a new frame pointers module.

Method Summary

Methods

Modifier and Type	Method and Description
short[]	getFrameNumbersOfInterest() Retrieves Frame number(s) selected as frames of interest.
java.lang.String[]	getFrameOfInterestType() Retrieves Frames Of Interest Type.
java.lang.String[]	getFramesOfInterestDescription() Retrieves Description of each one of the Frame(s) of Interest selected in (0028,6020).
short	getRepresentativeFrameNumber() Retrieves frame number selected for use as a pictorial representation (e.g.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setFrameNumbersOfInterest(short[] arrShFrameNumbersOfInterest) Frame number(s) selected as frames of interest.
void	setFrameOfInterestType(EnumFrameOfInterestType[] enumFrameOfInterestType) A defined term for each one of the Frame(s) of Interest (0028,6020) that identifies the significance of the frame.
void	setFramesOfInterestDescription(java.lang.String[] arrStrFramesOfInterestDescription) Description of each one of the Frame(s) of Interest selected in (0028,6020).
void	setRepresentativeFrameNumber(short sRepresentativeFrameNumber) The frame number selected for use as a pictorial representation (e.g.
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

FramePointersModule

public FramePointersModule(IDataSet objIDataSet)

Instantiates a new frame pointers 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:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setRepresentativeFrameNumber

public void setRepresentativeFrameNumber(short sRepresentativeFrameNumber)

The frame number selected for use as a pictorial representation (e.g. icon) of the Multi-frame Image

Parameters:

sRepresentativeFrameNumber - - the representative frame number

getRepresentativeFrameNumber

public short getRepresentativeFrameNumber()

Retrieves frame number selected for use as a pictorial representation (e.g. icon) of the Multi-frame Image

Returns:

the representative frame number

setFrameNumbersOfInterest

public void setFrameNumbersOfInterest(short[] arrShFrameNumbersOfInterest)

Frame number(s) selected as frames of interest. A frame number may appear more than once.

Parameters:

arrShFrameNumbersOfInterest - - the frame numbers of interest

getFrameNumbersOfInterest

public short[] getFrameNumbersOfInterest()

Retrieves Frame number(s) selected as frames of interest. A frame number may appear more than once.

Returns:

the frame numbers of interest

setFramesOfInterestDescription

public void setFramesOfInterestDescription(java.lang.String[] arrStrFramesOfInterestDescription)

Description of each one of the Frame(s) of Interest selected in (0028,6020). If multiple Frames of Interest are selected and this Attribute is used, it shall contain the same number of values as are in Frame Numbers of Interest (0028,6020).

Parameters:

arrStrFramesOfInterestDescription - - the frames of interest description

getFramesOfInterestDescription

public java.lang.String[] getFramesOfInterestDescription()

Retrieves Description of each one of the Frame(s) of Interest selected in (0028,6020).

Returns:

the frames of interest description

setFrameOfInterestType

public void setFrameOfInterestType(EnumFrameOfInterestType[] enumFrameOfInterestType)

A defined term for each one of the Frame(s) of Interest (0028,6020) that identifies the significance of the frame. Defined Terms are: HIGHMI = a frame acquired at the time of the high power pulse that destroys acoustic contrast ,RWAVE = the frame closest to the RWave TRIGGER = a trigger frame, for example a set delay from the R Wave, ENDSYSTOLE = the frame closest to end of systole, at the end of the T-wave

Parameters:

enumFrameOfInterestType - - array of the frame of interest type

getFrameOfInterestType

public java.lang.String[] getFrameOfInterestType()

Retrieves Frames Of Interest Type.

Returns:

the frame of interest type

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:

ISingleCollection - the customized collection containing the dataelement tags that beling to this module