cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class XRayCollimatorModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.XRayCollimatorModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class XRayCollimatorModule
extends Module

This Moudule specifies attributes related to XRay Collimator. An X-Ray Collimator is a device placed close to the X-Ray Source to restrict the span of the XRay beam.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
XRayCollimatorModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getCollimatorShape() Return shape(s) of the collimator.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the custom collection containing the list of DataElements belonging to the XRay Collimator Module specified by DICOM Standard.
XRayCollimatorDimensionsMacro	getXRayCollimatorDimensionsMacro() Returns instance of XRay Collimator Dimensions Macro.
void	setCollimatorShape(EnumCollimatorShape[] enumCollimatorShape) Sets shape(s) of the collimator.
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

XRayCollimatorModule

public XRayCollimatorModule(IDataSet objIDataSet)

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

setCollimatorShape

public void setCollimatorShape(EnumCollimatorShape[] enumCollimatorShape)

Sets shape(s) of the collimator. Enumerated Values: RECTANGULAR,CIRCULAR,POLYGONAL. This multi-valued Attribute shall contain at most one of each Enumerated Value.

Parameters:

enumCollimatorShape - the enum collimator shape

getCollimatorShape

public java.lang.String[] getCollimatorShape()

Return shape(s) of the collimator.

Returns:

String[] - String array of Collimator Shape

getXRayCollimatorDimensionsMacro

public XRayCollimatorDimensionsMacro getXRayCollimatorDimensionsMacro()

Returns instance of XRay Collimator Dimensions Macro.

Returns:

Instance of XRayCollimatorDimensionsMacro

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the XRay Collimator Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the XRay Collimator Module