cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ScanProcedureModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ScanProcedureModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ScanProcedureModule
extends Module

\* This module specifies the attributes of Scan Procedure Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ScanProcedureModule(IDataSet objIDataSet) Creates ScanProcedureModule

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDateTime() Retrieves date and time that the acquisition of data that resulted in this instance started.
java.lang.String	getAcquisitionNumber() Retrieves Acquisition Number.
java.lang.String	getInstanceNumber() Retrieves A number that identifies this instance.
RegistrationMethodCodeSequence	getRegistrationMethodCodeSequence() Retrieves pre-initialized object of Registration Method CodeSequence.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
double	getShotDurationTime() Retrieves the time in seconds from the start of this shot until the endof this shot.
double	getShotOffsetTime() Retrieves the time in seconds from the start of this shot until the start of this shot.
SurfaceScanAcquisitionTypeCodeSequence	getSurfaceScanAcquisitionTypeCodeSequence() Retrieves pre-initialized object of Surface Scan Acquisition TypeCode 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
SurfaceScanModeCodeSequence	getSurfaceScanModeCodeSequence() Retrieves pre-initialized object of Surface Scan Mode CodeSequence.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 of keys representing the DataElements that belong to this module.
void	setAcquisitionDateTime(java.lang.String strAcquisitionDateTime) Sets date and time that the acquisition of data that resulted in this instance started.
void	setAcquisitionNumber(java.lang.String strAcquisitionNumber) Sets Acquisition Number
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets A number that identifies this instance.
void	setShotDurationTime(double dblShotDurationTime) Sets the time in seconds from the start of this shot until the endof this shot.
void	setShotOffsetTime(double dblShotOffsetTime) Sets the time in seconds from the start of this shot until the start of this shot.
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

ScanProcedureModule

public ScanProcedureModule(IDataSet objIDataSet)

Creates ScanProcedureModule

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 - returns validation status as success or failure

Throws:

InvalidModuleException - If validation of Module fails

getSurfaceScanAcquisitionTypeCodeSequence

public SurfaceScanAcquisitionTypeCodeSequence getSurfaceScanAcquisitionTypeCodeSequence()

Retrieves pre-initialized object of Surface Scan Acquisition TypeCode 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

Returns:

SurfaceScanAcquisitionTypeCodeSequence - instance of Surface Scan Acquisition TypeCode Sequence.

getSurfaceScanModeCodeSequence

public SurfaceScanModeCodeSequence getSurfaceScanModeCodeSequence()

Retrieves pre-initialized object of Surface Scan Mode CodeSequence.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:

SurfaceScanModeCodeSequence - instance of Surface Scan Mode CodeSequence.

getRegistrationMethodCodeSequence

public RegistrationMethodCodeSequence getRegistrationMethodCodeSequence()

Retrieves pre-initialized object of Registration Method CodeSequence.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:

RegistrationMethodCodeSequence - instance of Registration Method CodeSequence

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.

setAcquisitionNumber

public void setAcquisitionNumber(java.lang.String strAcquisitionNumber)

Sets Acquisition Number

Parameters:

strAcquisitionNumber - - Acquisition Number.

getAcquisitionNumber

public java.lang.String getAcquisitionNumber()

Retrieves Acquisition Number.

Returns:

- String value of AcquisitionNumber.

setAcquisitionDateTime

public void setAcquisitionDateTime(java.lang.String strAcquisitionDateTime)

Sets date and time that the acquisition of data that resulted in this instance started.

Parameters:

strAcquisitionDateTime - String value of Acquisition DateTime

getAcquisitionDateTime

public java.lang.String getAcquisitionDateTime()

Retrieves date and time that the acquisition of data that resulted in this instance started.

Returns:

String - value of Acquisition DateTime

setShotDurationTime

public void setShotDurationTime(double dblShotDurationTime)

Sets the time in seconds from the start of this shot until the endof this shot.

Parameters:

dblShotDurationTime - Double value of Shot Duration Time

getShotDurationTime

public double getShotDurationTime()

Retrieves the time in seconds from the start of this shot until the endof this shot.

Returns:

double - double value of Shot Duration Time

setShotOffsetTime

public void setShotOffsetTime(double dblShotOffsetTime)

Sets the time in seconds from the start of this shot until the start of this shot.

Parameters:

dblShotOffsetTime - Double value of ShotOffsetTime

getShotOffsetTime

public double getShotOffsetTime()

Retrieves the time in seconds from the start of this shot until the start of this shot.

Returns:

double - double value of ShotOffsetTime

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.