cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SpatialRegistrationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SpatialRegistrationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SpatialRegistrationModule
extends Module

\* This module specifies the Attributes that describe Spatial Registration Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SpatialRegistrationModule(IDataSet objIDataSet) Instantiates a new spatial registration module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentDate() Return date the content creation started.
ContentIdentificationMacro	getContentIdentificationMacro() Get the Instance of Content Identification Macro.Attributes related to Content Identification Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first.
java.lang.String	getContentTime() Return time the content creation started.
RegistrationSequence	getRegistrationSequence() Retrieves pre-initialized object of RegistrationSequence.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
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the Spatial Registration Module specified by DICOM Standard.
void	setContentDate(java.lang.String strContentDate) Sets attribute identifies date the content creation started.
void	setContentTime(java.lang.String strContentTime) Sets attribute identifies time the content creation started.
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

SpatialRegistrationModule

public SpatialRegistrationModule(IDataSet objIDataSet)

Instantiates a new spatial registration module.

Parameters:

objIDataSet - the obj i data set

Method Detail

getContentIdentificationMacro

public ContentIdentificationMacro getContentIdentificationMacro()

Get the Instance of Content Identification Macro.Attributes related to Content Identification Macro will be set in Macro using the setter methods provided in the Macro.Calling this method multiple times will return the same Marco Instance that was created at first. Hence, any attributes in this Macro,if set multiple times will contain the value that was set in the last call to its setter method.

Returns:

- object of code sequence macro which the user programmer can populate

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets attribute identifies date the content creation started.

Parameters:

strContentDate - - String identifies date.

getContentDate

public java.lang.String getContentDate()

Return date the content creation started.

Returns:

String - String identifies date the content creation started.

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets attribute identifies time the content creation started.

Parameters:

strContentTime - - String identifies time

getContentTime

public java.lang.String getContentTime()

Return time the content creation started.

Returns:

String - String identifies time.

getRegistrationSequence

public RegistrationSequence getRegistrationSequence()

Retrieves pre-initialized object of RegistrationSequence.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

Returns:

RegistrationSequence - instance of Referenced Reference Image Sequence.

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 - the invalid module exception

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector containing the list of DataElements belonging to the Spatial Registration Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the Spatial Registration Series Module