cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class FrameOfReferenceModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FrameOfReferenceModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class FrameOfReferenceModule
extends Module

\* The class FrameOfReferenceModule.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FrameOfReferenceModule(IDataSet objIDataSet) Instantiates a new frame of reference module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFrameOfReferenceUID() Retrieves the Frame of reference UID.
java.lang.String	getPositionReferenceIndicator() Retrieves the Position Reference Indicator.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setFrameOfReferenceUID(java.lang.String strFrameOfReferenceUID) The method is used to set Uniquely identified frame of reference for a Series.
void	setPositionReferenceIndicator(java.lang.String strPositionReferenceIndicator) The method is used to set Part of the patient's anatomy used as a reference.
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

FrameOfReferenceModule

public FrameOfReferenceModule(IDataSet objIDataSet)

Instantiates a new frame of reference 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

setFrameOfReferenceUID

public void setFrameOfReferenceUID(java.lang.String strFrameOfReferenceUID)

The method is used to set Uniquely identified frame of reference for a Series. The function accepts a String Value as the strStudyInstanceUID and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strFrameOfReferenceUID - - Unique identifier for the Study.

setPositionReferenceIndicator

public void setPositionReferenceIndicator(java.lang.String strPositionReferenceIndicator)

The method is used to set Part of the patient's anatomy used as a reference. The function accepts a String Value as the strStudyInstanceUID and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strPositionReferenceIndicator - - String value for Position Reference Indicator

getFrameOfReferenceUID

public java.lang.String getFrameOfReferenceUID()

Retrieves the Frame of reference UID.

Returns:

- returns the frame of reference UID

getPositionReferenceIndicator

public java.lang.String getPositionReferenceIndicator()

Retrieves the Position Reference Indicator.

Returns:

- returns the Position Reference Indicator

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