cdac.medinfo.sdk.dcm30_04.baselibs

Class CalculatedDoseReferenceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.CalculatedDoseReferenceSequenceItem

All Implemented Interfaces:

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

public class CalculatedDoseReferenceSequenceItem
extends Item

This item introduces sequence of doses estimated for each treatment delivery, sequence may contain one or more items.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCalculatedDoseReferenceDescription() Retrieves User-defined description of Calculated Dose Reference.
java.lang.String	getCalculatedDoseReferenceDoseValue() Retrieves Calculated Dose Reference Dose Value.
java.lang.String	getCalculatedDoseReferenceNumber() Retrieves Calculated Dose Reference Number.
java.lang.String	getReferencedDoseReferenceNumber() Retrieves Referenced Dose Reference Number.
void	setCalculatedDoseReferenceDescription(java.lang.String strCalculatedDoseReferenceDescription) Sets User-defined description of Calculated Dose Reference.
void	setCalculatedDoseReferenceDoseValue(java.lang.String strCalculatedDoseReferenceDoseValue) Sets Calculated Dose(Gy).
void	setCalculatedDoseReferenceNumber(java.lang.String strCalculatedDoseReferenceNumber) Sets Calculated Dose Reference Number.
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 CalculatedDoseReferenceSequenceItem 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.

setCalculatedDoseReferenceNumber

public void setCalculatedDoseReferenceNumber(java.lang.String strCalculatedDoseReferenceNumber)

Sets Calculated Dose Reference Number. Unique identifier of dose reference point within RT Treatment Record IOD.

Parameters:

strCalculatedDoseReferenceNumber- - String value of Calculated Dose Reference Number .

getCalculatedDoseReferenceNumber

public java.lang.String getCalculatedDoseReferenceNumber()

Retrieves Calculated Dose Reference Number.

Returns:

String - value of Calculated Dose Reference Number.

setCalculatedDoseReferenceDoseValue

public void setCalculatedDoseReferenceDoseValue(java.lang.String strCalculatedDoseReferenceDoseValue)

Sets Calculated Dose(Gy).

Parameters:

strCalculatedDoseReferenceDoseValue- - String value of Calculated Dose Reference Dose Value .

getCalculatedDoseReferenceDoseValue

public java.lang.String getCalculatedDoseReferenceDoseValue()

Retrieves Calculated Dose Reference Dose Value.

Returns:

String - value of String value of Calculated Dose Reference Dose Value.

setCalculatedDoseReferenceDescription

public void setCalculatedDoseReferenceDescription(java.lang.String strCalculatedDoseReferenceDescription)

Sets User-defined description of Calculated Dose Reference.

Parameters:

strCalculatedDoseReferenceDescription - -String value of Calculated Dose Reference Description .

getCalculatedDoseReferenceDescription

public java.lang.String getCalculatedDoseReferenceDescription()

Retrieves User-defined description of Calculated Dose Reference.

Returns:

String - value of Calculated Dose Reference Description.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in CalculatedDoseReferenceSequenceItem 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.