cdac.medinfo.sdk.dcm30_04.baselibs

Class RTDoseROISequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.RTDoseROISequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class RTDoseROISequenceItem
extends Item

This item class contains the methods to set,get and validate the attribute present in RT Dose ROI Sequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDoseUnits() Retrieves Dose axis units.
java.lang.String	getDoseValue() Retrieves Dose value for ROI, in units defined by Dose Units (3004,0002).
java.lang.String	getReferencedROINumber() Retrieves value that uniquely identifies the referenced ROI within the current RT Dose.
void	setDoseUnits(EnumDoseUnits enumDoseUnits) Sets Dose axis units.
void	setDoseValue(java.lang.String strDoseValue) Sets Dose value for ROI, in units defined by Dose Units (3004,0002).
void	setReferencedROINumber(java.lang.String strReferencedROINumber) Sets value that uniquely identifies the referenced ROI within the current RT Dose.
boolean	validateForModule() Validates all the attributes in RTDoseROISequenceItem that are present in the DataSet

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

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

setReferencedROINumber

public void setReferencedROINumber(java.lang.String strReferencedROINumber)

Sets value that uniquely identifies the referenced ROI within the current RT Dose.

Parameters:

strReferencedROINumber - String value of Referenced ROI Number.

getReferencedROINumber

public java.lang.String getReferencedROINumber()

Retrieves value that uniquely identifies the referenced ROI within the current RT Dose.

Returns:

String - value of Referenced ROI Number.

setDoseUnits

public void setDoseUnits(EnumDoseUnits enumDoseUnits)

Sets Dose axis units. Enumerated Values: GY = Gray, RELATIVE = dose relative to reference value specified in DVH Normalization Dose Value (3004,0042).

Parameters:

enumDoseUnits - Enum value of Dose Units

getDoseUnits

public java.lang.String getDoseUnits()

Retrieves Dose axis units.

Returns:

String - value of Dose Units.

setDoseValue

public void setDoseValue(java.lang.String strDoseValue)

Sets Dose value for ROI, in units defined by Dose Units (3004,0002).

Parameters:

strDoseValue - String value of Dose Value.

getDoseValue

public java.lang.String getDoseValue()

Retrieves Dose value for ROI, in units defined by Dose Units (3004,0002).

Returns:

String - value of Dose Value.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in RTDoseROISequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.