cdac.medinfo.sdk.dcm30_04.baselibs

Class ExposureIndexMacro

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Macro

cdac.medinfo.sdk.dcm30_04.baselibs.ExposureIndexMacro

All Implemented Interfaces:

IMacro, java.io.Serializable

public class ExposureIndexMacro
extends Macro

This class contains Macro that describes the attributes for describes the Exposure Index for single projection X-ray images, as described by IEC 62494-1 and the report of AAPM Task Group 116.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExposureIndexMacro(IDataSet objDataSet) This constructor constructs a Macro with specified DataSet.
ExposureIndexMacro(IDataSet objDataSet, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with specified DataSet and DictionaryReader
ExposureIndexMacro(IItem objItem) This constructor constructs a Macro with the specified Item
ExposureIndexMacro(IItem objItem, IDictionaryReader objDictionaryReader) This constructor constructs a Macro with the specified Item and Dictionary Reader

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDeviationIndex() Retrieves Deviation Index
IDictionaryReader	getDictionaryReader() Retrieves the Dictionary reader set in the Item
java.lang.String	getExposureIndex() Retrieves Exposure Index.
java.lang.String	getTargetExposureIndex() Retrieves Exposure Index.
void	setDeviationIndex(java.lang.String strDeviationIndex) Sets Deviation Index
void	setExposureIndex(java.lang.String strExposureIndex) Sets Exposure Index
void	setTargetExposureIndex(java.lang.String strExposureIndex) Sets Target Exposure Index
boolean	validate() Validates all the attributes in ExposureIndexMacro
boolean	validate(IDataSet objIDataSet) Validates all the attributes in Exposure Index Macro that are present in the DataSet
static boolean	validate(IItem objIItem) Validates all the attributes in Exposure Index Macro that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Macro

addDataElement, clone, contains, getDataElement, getTransferSyntax

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExposureIndexMacro

public ExposureIndexMacro(IDataSet objDataSet)

This constructor constructs a Macro with specified DataSet.

Parameters:

objDataSet - Collection of Data Elements

ExposureIndexMacro

public ExposureIndexMacro(IDataSet objDataSet,
                  IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with specified DataSet and DictionaryReader

Parameters:

objDataSet - specifies the DataSet

objDictionaryReader - specifies the DICOM Dictionary reader to be used

ExposureIndexMacro

public ExposureIndexMacro(IItem objItem)

This constructor constructs a Macro with the specified Item

Parameters:

objItem - specifies instance of Item class

ExposureIndexMacro

public ExposureIndexMacro(IItem objItem,
                  IDictionaryReader objDictionaryReader)

This constructor constructs a Macro with the specified Item and Dictionary Reader

Parameters:

objItem - specifies instance of Item class

objDictionaryReader - specifies the DICOM Dictionary reader to be used

Method Detail

getDictionaryReader

public IDictionaryReader getDictionaryReader()

Retrieves the Dictionary reader set in the Item

Returns:

IDictionaryReader - DictionaryReader set in the Item

setExposureIndex

public void setExposureIndex(java.lang.String strExposureIndex)

Sets Exposure Index

Parameters:

strExposureIndex - String value of Exposure Index

getExposureIndex

public java.lang.String getExposureIndex()

Retrieves Exposure Index.

Returns:

String - value of Exposure Index.

setTargetExposureIndex

public void setTargetExposureIndex(java.lang.String strExposureIndex)

Sets Target Exposure Index

Parameters:

strTargetExposureIndex - String value of Target Exposure Index

getTargetExposureIndex

public java.lang.String getTargetExposureIndex()

Retrieves Exposure Index.

Returns:

String - value of Exposure Index.

setDeviationIndex

public void setDeviationIndex(java.lang.String strDeviationIndex)

Sets Deviation Index

Parameters:

strDeviationIndex - String value of Deviation Index

getDeviationIndex

public java.lang.String getDeviationIndex()

Retrieves Deviation Index

Returns:

String - value of Deviation Index

validate

public boolean validate()
                 throws InvalidMacroException

Validates all the attributes in ExposureIndexMacro

Returns:

boolean - Success -true, Failure -false.

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public boolean validate(IDataSet objIDataSet)
                 throws InvalidMacroException

Validates all the attributes in Exposure Index Macro that are present in the DataSet

Parameters:

objIDataSet - collection of DataElements

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.

validate

public static boolean validate(IItem objIItem)
                        throws InvalidMacroException

Validates all the attributes in Exposure Index Macro that are present in the DataSet

Parameters:

objIItem - collection of DataElements in a sequence

Returns:

boolean Success -true, Failure - false

Throws:

InvalidMacroException - throws InvalidMacroException If Mandatory or Conditional element fails.