cdac.medinfo.sdk.dcm30_04.baselibs

Class MeasuredDoseReferenceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.MeasuredDoseReferenceSequenceItem

All Implemented Interfaces:

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

public class MeasuredDoseReferenceSequenceItem
extends Item

This item introduces sequence of doses measured during treatment delivery, summed over entire session. The sequence may contain one or more items.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	geMeasuredDoseType() Retrieves Type of dose measurement.
java.lang.String	getDoseUnits() Retrieves units used to describe measured dose.
java.lang.String	getMeasuredDoseDescription() Retrieves User-defined description of Dose Reference.
java.lang.String	getMeasuredDoseReferenceNumber() Retrieves Measured Dose Reference Number.
java.lang.String	getMeasuredDoseValue() Retrieves Measured Dose in units specified by Dose Units (3004, 0002).
java.lang.String	getReferencedDoseReferenceNumber() Retrieves Referenced Dose Reference Number.
void	setDoseUnits(EnumDoseUnits enumDoseUnits) Sets units used to describe measured dose.
void	setMeasuredDoseDescription(java.lang.String strMeasuredDoseDescription) Sets User-defined description of Dose Reference.
void	setMeasuredDoseReferenceNumber(java.lang.String strMeasuredDoseReferenceNumber) Sets Measured Dose Reference Number.
void	setMeasuredDoseType(EnumMeasuredDoseType enumMeasuredDoseType) Sets Type of dose measurement.
void	setMeasuredDoseValue(java.lang.String strMeasuredDoseValue) Sets Measured Dose in units specified by Dose Units (3004, 0002).
void	setReferencedDoseReferenceNumber(java.lang.String strReferencedDoseReferenceNumber) Sets Referenced Dose Reference Number .Uniquely identifies Dose Reference specified by Dose Reference Number(300A,0012) in Dose Reference Sequence(300A,0010) in RT Prescription Module of referenced RT Plan.
boolean	validateForModule() Validates all the attributes in MeasuredDoseReferenceSequenceItem 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

setReferencedDoseReferenceNumber

public void setReferencedDoseReferenceNumber(java.lang.String strReferencedDoseReferenceNumber)

Sets Referenced Dose Reference Number .Uniquely identifies Dose Reference specified by Dose Reference Number(300A,0012) in Dose Reference Sequence(300A,0010) in RT Prescription Module of referenced RT Plan.

Parameters:

strReferencedDoseReferenceNumber - String value of Referenced Dose Reference Number.

getReferencedDoseReferenceNumber

public java.lang.String getReferencedDoseReferenceNumber()

Retrieves Referenced Dose Reference Number.

Returns:

String - value of Referenced Dose Reference Number.

setMeasuredDoseReferenceNumber

public void setMeasuredDoseReferenceNumber(java.lang.String strMeasuredDoseReferenceNumber)

Sets Measured Dose Reference Number. Unique identifier of measured dose point.

Parameters:

strMeasuredDoseReferenceNumber - String value of Measured Dose Reference Number .

getMeasuredDoseReferenceNumber

public java.lang.String getMeasuredDoseReferenceNumber()

Retrieves Measured Dose Reference Number.

Returns:

String - value of Measured Dose Reference Number.

setDoseUnits

public void setDoseUnits(EnumDoseUnits enumDoseUnits)

Sets units used to describe measured dose.

Parameters:

enumDoseUnits - Enum Value of Dose Units Enumerated Values: GY = Gray, RELATIVE = Dose relative to implicit reference value

getDoseUnits

public java.lang.String getDoseUnits()

Retrieves units used to describe measured dose.

Returns:

String - value of Dose Units.

setMeasuredDoseValue

public void setMeasuredDoseValue(java.lang.String strMeasuredDoseValue)

Sets Measured Dose in units specified by Dose Units (3004, 0002).

Parameters:

strMeasuredDoseValue - String value of Measured Dose Value .

getMeasuredDoseValue

public java.lang.String getMeasuredDoseValue()

Retrieves Measured Dose in units specified by Dose Units (3004, 0002).

Returns:

String - value of Measured Dose Value.

setMeasuredDoseDescription

public void setMeasuredDoseDescription(java.lang.String strMeasuredDoseDescription)

Sets User-defined description of Dose Reference.

Parameters:

strMeasuredDoseDescription - String value of Measured Dose Description .

getMeasuredDoseDescription

public java.lang.String getMeasuredDoseDescription()

Retrieves User-defined description of Dose Reference.

Returns:

String - value of Measured Dose Description.

setMeasuredDoseType

public void setMeasuredDoseType(EnumMeasuredDoseType enumMeasuredDoseType)

Sets Type of dose measurement.

Parameters:

enumMeasuredDoseType - Enum value of Measured Dose Type Defined Terms: DIODE = semiconductor diode, TLD = thermoluminescent dosimeter, ION_CHAMBER = ion chamber, GEL = dose sensitive gel, EPID = electronic portal imaging device, FILM = dose sensitive film.

geMeasuredDoseType

public java.lang.String geMeasuredDoseType()

Retrieves Type of dose measurement.

Returns:

String - value of Measured Dose Type.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

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

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

int - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.