cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class RadiationDoseModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.RadiationDoseModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class RadiationDoseModule
extends Module

\* This module describes the attributes in Radiation Dose Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
RadiationDoseModule(IDataSet objIDataSet) Creates Annotation List Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
AnatomicStructureSpaceorRegionSequence	getAnatomicStructureSpaceorRegionSequence() Retrieves pre-initialized object of AnatomicStructureSpaceorRegionSequence.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
java.lang.String	getCommentsonRadiationDose() Return attribute identifies User-defined comments on any special conditions related to radiation dose encountered during this Performed Procedure Step.
java.lang.String	getDistanceSourcetoDetector() Return Distance in mm from the source to detector center.
java.lang.String	getDistanceSourcetoEntrance() Return attribute identifies Distance in mm from the source to the surface of the patient closest to the source during this Performed Procedure Step.
short	getEntranceDose() Retrieves Average entrance dose value measured in dGy at the surface of the patient during this Performed Procedure Step.
java.lang.String	getEntranceDoseinmGy() Return attribute identifies Average entrance dose value measured in mGy at the surface of the patient during this Performed Procedure Step.
java.lang.Short[]	getExposedArea() Return attribute identifies Typical dimension of the exposed area at the detector plane.
ExposureDoseSequence	getExposureDoseSequence() Retrieves pre-initialized object of ExposureDoseSequence.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
java.lang.String	getImageAreaDoseProduct() Return identifies Total area-dose-product to which the patient was exposed, accumulated over the complete Performed Procedure Step and measured in dGy*cm*cm, including fluoroscopy.
short	getTotalNumberofExposures() Retrieves total number of exposures made during this Performed Procedure Step.
short	getTotalTimeofFluoroscopy() Retrieves Total duration of X-Ray exposure during fluoroscopy in seconds (pedal time) during this Performed Procedure Step.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setCommentsonRadiationDose(java.lang.String StrCommentsonRadiationDose) Sets attribute identifies User-defined comments on any special conditions related to radiation dose encountered during this Performed Procedure Step.
void	setDistanceSourcetoDetector(java.lang.String strDistanceSourcetoDetector) Sets attribute identifies Distance in mm from the source to detector center.
void	setDistanceSourcetoEntrance(java.lang.String StrDistanceSourcetoEntrance) Sets attribute identifies Distance in mm from the source to the surface of the patient closest to the source during this Performed Procedure Step.
void	setEntranceDose(short shEntranceDose) Sets Average entrance dose value measured in dGy at the surface of the patient during this Performed Procedure Step.
void	setEntranceDoseinmGy(java.lang.String StrEntranceDoseinmGy) Sets attribute identifies Average entrance dose value measured in mGy at the surface of the patient during this Performed Procedure Step.
void	setExposedArea(java.lang.Short[] arrShExposedArea) Sets attribute identifies Typical dimension of the exposed area at the detector plane.
void	setImageAreaDoseProduct(java.lang.String StrImageAreaDoseProduct) Sets attribute identifies Total area-dose-product to which the patient was exposed, accumulated over the complete Performed Procedure Step and measured in dGy*cm*cm, including fluoroscopy.
void	setTotalNumberofExposures(short shTotalNumberofExposures) Sets Total number of exposures made during this Performed Procedure Step.
void	setTotalTimeofFluoroscopy(short shTotalTimeofFluoroscopy) Sets Total duration of X-Ray exposure during fluoroscopy in seconds (pedal time) during this Performed Procedure Step.
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

RadiationDoseModule

public RadiationDoseModule(IDataSet objIDataSet)

Creates Annotation List Module with default initialization.

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:

- validation status as success or failure

Throws:

InvalidModuleException - when the module is invalid

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

getAnatomicStructureSpaceorRegionSequence

public AnatomicStructureSpaceorRegionSequence getAnatomicStructureSpaceorRegionSequence()

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

AnatomicStructureSpaceorRegionSequence - instance of Anatomic Structure Space or Region Sequence

setTotalTimeofFluoroscopy

public void setTotalTimeofFluoroscopy(short shTotalTimeofFluoroscopy)

Sets Total duration of X-Ray exposure during fluoroscopy in seconds (pedal time) during this Performed Procedure Step.

Parameters:

shTotalTimeofFluoroscopy - short value of total duration.

getTotalTimeofFluoroscopy

public short getTotalTimeofFluoroscopy()

Retrieves Total duration of X-Ray exposure during fluoroscopy in seconds (pedal time) during this Performed Procedure Step.

Returns:

short - short value of Total duration.

setTotalNumberofExposures

public void setTotalNumberofExposures(short shTotalNumberofExposures)

Sets Total number of exposures made during this Performed Procedure Step. The number includes non-digital and digital exposures.

Parameters:

shTotalNumberofExposures - short value of total number of exposures made

getTotalNumberofExposures

public short getTotalNumberofExposures()

Retrieves total number of exposures made during this Performed Procedure Step. The number includes non-digital and digital exposures.

Returns:

short - short value of total number of exposures made

setDistanceSourcetoDetector

public void setDistanceSourcetoDetector(java.lang.String strDistanceSourcetoDetector)

Sets attribute identifies Distance in mm from the source to detector center.

Parameters:

strDistanceSourcetoDetector - - String identifies Distance in mm from the source to detector center.

getDistanceSourcetoDetector

public java.lang.String getDistanceSourcetoDetector()

Return Distance in mm from the source to detector center.

Returns:

String - String identifies the Distance in mm from the source to detector center.

setDistanceSourcetoEntrance

public void setDistanceSourcetoEntrance(java.lang.String StrDistanceSourcetoEntrance)

Sets attribute identifies Distance in mm from the source to the surface of the patient closest to the source during this Performed Procedure Step.

Parameters:

StrDistanceSourcetoEntrance - - String identifies the Distance in mm

getDistanceSourcetoEntrance

public java.lang.String getDistanceSourcetoEntrance()

Return attribute identifies Distance in mm from the source to the surface of the patient closest to the source during this Performed Procedure Step.

Returns:

String - String identifies the Distance in mm

setEntranceDose

public void setEntranceDose(short shEntranceDose)

Sets Average entrance dose value measured in dGy at the surface of the patient during this Performed Procedure Step.

Parameters:

shEntranceDose - short value of Average entrance dose.

getEntranceDose

public short getEntranceDose()

Retrieves Average entrance dose value measured in dGy at the surface of the patient during this Performed Procedure Step.

Returns:

short - short value of Average entrance dose.

setEntranceDoseinmGy

public void setEntranceDoseinmGy(java.lang.String StrEntranceDoseinmGy)

Sets attribute identifies Average entrance dose value measured in mGy at the surface of the patient during this Performed Procedure Step.

Parameters:

StrEntranceDoseinmGy - - String identifies Average entrance dose value

getEntranceDoseinmGy

public java.lang.String getEntranceDoseinmGy()

Return attribute identifies Average entrance dose value measured in mGy at the surface of the patient during this Performed Procedure Step.

Returns:

String - String identifies the Average entrance dose value

setExposedArea

public void setExposedArea(java.lang.Short[] arrShExposedArea)

Sets attribute identifies Typical dimension of the exposed area at the detector plane. If Rectangular: row dimension followed by column;

Parameters:

arrShExposedArea - - Short array of typical dimension of the exposed area

getExposedArea

public java.lang.Short[] getExposedArea()

Return attribute identifies Typical dimension of the exposed area at the detector plane. If Rectangular: row dimension followed by column;

Returns:

Short[]- Short array of typical dimension of the exposed area

setImageAreaDoseProduct

public void setImageAreaDoseProduct(java.lang.String StrImageAreaDoseProduct)

Sets attribute identifies Total area-dose-product to which the patient was exposed, accumulated over the complete Performed Procedure Step and measured in dGy*cm*cm, including fluoroscopy.

Parameters:

StrImageAreaDoseProduct - - String identifies Total area-dose-product

getImageAreaDoseProduct

public java.lang.String getImageAreaDoseProduct()

Return identifies Total area-dose-product to which the patient was exposed, accumulated over the complete Performed Procedure Step and measured in dGy*cm*cm, including fluoroscopy.

Returns:

String - String identifies Total area-dose-product

setCommentsonRadiationDose

public void setCommentsonRadiationDose(java.lang.String StrCommentsonRadiationDose)

Sets attribute identifies User-defined comments on any special conditions related to radiation dose encountered during this Performed Procedure Step.

Parameters:

StrCommentsonRadiationDose - - String identifies User-defined comments

getCommentsonRadiationDose

public java.lang.String getCommentsonRadiationDose()

Return attribute identifies User-defined comments on any special conditions related to radiation dose encountered during this Performed Procedure Step.

Returns:

String - String identifies User-defined comments

getExposureDoseSequence

public ExposureDoseSequence getExposureDoseSequence()

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

ExposureDoseSequence - instance of Exposure Dose Sequence