cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XAOrXRFMultiframePresentationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XAOrXRFMultiframePresentationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XAOrXRFMultiframePresentationModule
extends Module

\* This module describes attributes related to XA Or XRF Multiframe Presentation Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XAOrXRFMultiframePresentationModule(IDataSet objIDataSet) Instantiates a new waveform identification module.

Method Summary

Methods

Modifier and Type	Method and Description
FrameDisplaySequence	getFrameDisplaySequence() This method provides the pre-initialized object of Frame Display Sequence.
short	getPreferredPlaybackSequencing() Retrieves the preferred playback sequencing for a multi-frame image.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setPreferredPlaybackSequencing(short sPreferredPlaybackSequencing) Sets the preferred playback sequencing for a multi-frame image.
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

XAOrXRFMultiframePresentationModule

public XAOrXRFMultiframePresentationModule(IDataSet objIDataSet)

Instantiates a new waveform identification module.

Parameters:

objIDataSet - the obj i data set

Method Detail

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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

Overrides:

getVectorOfKeys in class Module

Returns:

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

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

setPreferredPlaybackSequencing

public void setPreferredPlaybackSequencing(short sPreferredPlaybackSequencing)

Sets the preferred playback sequencing for a multi-frame image. Enumerated Values: 0 = Looping (1,2...n,1,2,...n,1,2,....n,...) 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...).

Parameters:

sPreferredPlaybackSequencing - short value of Preferred Playback Sequencing.

getPreferredPlaybackSequencing

public short getPreferredPlaybackSequencing()

Retrieves the preferred playback sequencing for a multi-frame image. Enumerated Values: 0 = Looping (1,2...n,1,2,...n,1,2,....n,...) 1 = Sweeping (1,2,...n,n-1,...2,1,2,...n,...)

Returns:

short - short value of Preferred Playback Sequencing.

getFrameDisplaySequence

public FrameDisplaySequence getFrameDisplaySequence()

This method provides the pre-initialized object of Frame Display Sequence.

Returns:

- object of Frame Display Sequence. If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence