cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MultiFrameFunctionalGroupsModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameFunctionalGroupsModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MultiFrameFunctionalGroupsModule
extends Module

\* This module specifies the attributes of the Multi-frame Functional Groups Module. This module is included in SOP instances even if there is only one frame in the instance.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MultiFrameFunctionalGroupsModule(IDataSet objIDataSet) Instantiates a new multi frame functional groups module.

Method Summary

Methods

Modifier and Type	Method and Description
long	getConcatenationFrameOffsetNumber() Retrieves Offset of the first frame in a multi-frame image of a concatenation.
java.lang.String	getConcatenationUID() Retrieves Identifier of all SOP Instances that belong to the same concatenation.
java.lang.String	getContentDate() Retrieves The date the data creation was started.
java.lang.String	getContentTime() Retrieves The time the data creation was started.
short	getInConcatenationNumber() Retrieves IIdentifier for one SOP Instance belonging to a concatenation.
java.lang.String	getInstanceNumber() Retrieves A number that identifies this instance.
java.lang.String	getNumberOfFrames() Retrieves Number of frames in a multi-frame image..
short	getRepresentativeFrameNumber() Retrieves The frame number selected for use as a pictorial representation (e.g.
java.lang.String	getSOPInstanceUIDOfConcatenationSource() Retrieves SOP Instance UID of the single composite SOP Instance of which the Concatenation is a part.
java.lang.String	getStereoPairsPresent() Returns the multi-frame pixel data consists of left and right stereoscopic pairs.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setConcatenationFrameOffsetNumber(long dConcatenationFrameOffsetNumber) Sets Offset of the first frame in a multi-frame image of a concatenation.
void	setConcatenationUID(java.lang.String strConcatenationUID) Sets Identifier of all SOP Instances that belong to the same concatenation.
void	setContentDate(java.lang.String strContentDate) Sets The date the data creation was started.
void	setContentTime(java.lang.String strContentTime) Sets The time the data creation was started.
void	setInConcatenationNumber(short shInConcatenationNumber) Sets Identifier for one SOP Instance belonging to a concatenation.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets A number that identifies this instance.
void	setNumberOfFrames(java.lang.String strNumberOfFrames) Sets Number of frames in a multi-frame image.
void	setRepresentativeFrameNumber(short shRepresentativeFrameNumber) Sets The frame number selected for use as a pictorial representation (e.g.
void	setSOPInstanceUIDOfConcatenationSource(java.lang.String strSOPInstanceUIDOfConcatenationSource) Sets SOP Instance UID of the single composite SOP Instance of which the Concatenation is a part.
void	setStereoPairsPresent(EnumStereoPairsPresent enumStereoPairsPresent) Sets the multi-frame pixel data consists of left and right stereoscopic pairs.
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

MultiFrameFunctionalGroupsModule

public MultiFrameFunctionalGroupsModule(IDataSet objIDataSet)

Instantiates a new multi frame functional groups 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 - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets A number that identifies this instance.

Parameters:

strInstanceNumber - - A number that identifies this instance.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves A number that identifies this instance.

Returns:

- String value of Instance Number.

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets The date the data creation was started.

Parameters:

strContentDate - - The date the data creation was started.

getContentDate

public java.lang.String getContentDate()

Retrieves The date the data creation was started.

Returns:

- String value of Content Date.

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets The time the data creation was started.

Parameters:

strContentTime - - The time the data creation was started.

getContentTime

public java.lang.String getContentTime()

Retrieves The time the data creation was started.

Returns:

- String value of Content Time.

setNumberOfFrames

public void setNumberOfFrames(java.lang.String strNumberOfFrames)

Sets Number of frames in a multi-frame image.

Parameters:

strNumberOfFrames - - Number of frames in a multi-frame image.

getNumberOfFrames

public java.lang.String getNumberOfFrames()

Retrieves Number of frames in a multi-frame image..

Returns:

- String value of Number of frames in a multi-frame image..

setStereoPairsPresent

public void setStereoPairsPresent(EnumStereoPairsPresent enumStereoPairsPresent)

Sets the multi-frame pixel data consists of left and right stereoscopic pairs. Enumerated Values: YES. NO.

Parameters:

enumStereoPairsPresent - String value of Stereo Pairs Present.

getStereoPairsPresent

public java.lang.String getStereoPairsPresent()

Returns the multi-frame pixel data consists of left and right stereoscopic pairs.

Returns:

String - String value of Stereo Pairs Present.

setConcatenationFrameOffsetNumber

public void setConcatenationFrameOffsetNumber(long dConcatenationFrameOffsetNumber)

Sets Offset of the first frame in a multi-frame image of a concatenation.

Parameters:

dConcatenationFrameOffsetNumber - - Offset of the first frame in a multi-frame image of a concatenation.

getConcatenationFrameOffsetNumber

public long getConcatenationFrameOffsetNumber()

Retrieves Offset of the first frame in a multi-frame image of a concatenation.

Returns:

- Double value of Concatenation Frame Offset Number.

setRepresentativeFrameNumber

public void setRepresentativeFrameNumber(short shRepresentativeFrameNumber)

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

Parameters:

shRepresentativeFrameNumber - - Short value of Representative Frame Number.

getRepresentativeFrameNumber

public short getRepresentativeFrameNumber()

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

Returns:

- Short value of Representative Frame Number.

setConcatenationUID

public void setConcatenationUID(java.lang.String strConcatenationUID)

Sets Identifier of all SOP Instances that belong to the same concatenation.

Parameters:

strConcatenationUID - - String value of Concatenation UID.

getConcatenationUID

public java.lang.String getConcatenationUID()

Retrieves Identifier of all SOP Instances that belong to the same concatenation.

Returns:

- String value of Concatenation UID.

setSOPInstanceUIDOfConcatenationSource

public void setSOPInstanceUIDOfConcatenationSource(java.lang.String strSOPInstanceUIDOfConcatenationSource)

Sets SOP Instance UID of the single composite SOP Instance of which the Concatenation is a part. All SOP Instances of a concatenation shalluse the same value for this attribute.

Parameters:

strSOPInstanceUIDOfConcatenationSource - - String value of Concatenation UID.

getSOPInstanceUIDOfConcatenationSource

public java.lang.String getSOPInstanceUIDOfConcatenationSource()

Retrieves SOP Instance UID of the single composite SOP Instance of which the Concatenation is a part. All SOP Instances of a concatenation shalluse the same value for this attribute.

Returns:

- String value of SOPInstanceUIDOfConcatenationSource.

setInConcatenationNumber

public void setInConcatenationNumber(short shInConcatenationNumber)

Sets Identifier for one SOP Instance belonging to a concatenation.

Parameters:

shInConcatenationNumber - - short value of In Concatenation Number.

getInConcatenationNumber

public short getInConcatenationNumber()

Retrieves IIdentifier for one SOP Instance belonging to a concatenation.

Returns:

- String value of In Concatenation Number.

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:

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