cdac.medinfo.sdk.dcm30_04.baselibs

Class ReferencedDoseReferenceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.ReferencedDoseReferenceSequenceItem

All Implemented Interfaces:

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

public class ReferencedDoseReferenceSequenceItem
extends Item

This item class contains methods to validate,set and get the attributes in ReferencedDoseReferenceSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConstraintWeight() Retrieves value that describes relative importance of satisfying constraint, where high values represent more important constraints.
java.lang.String	getCumulativeDoseReferenceCoefficient() Retrieves Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point.
java.lang.String	getDeliveryMaximumDose() Retrieves the maximum dose (in Gy) which can be delivered to the dose reference.
java.lang.String	getDeliveryWarningDose() Retrieves the dose (in Gy) which when reached or exceeded should cause some action to be taken.
java.lang.String	getOrganAtRiskFullVolumeDose() Retrieves maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
java.lang.String	getOrganAtRiskLimitDose() Retrieves maximum permitted dose (in Gy) to any part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
java.lang.String	getOrganAtRiskMaximumDose() Retrieves maximum dose (in Gy) to non-overdosed part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
java.lang.String	getOrganAtRiskOverdoseVolumeFraction() Retrieves maximum permitted fraction (in percent) of Organ at Risk to receive more than the Organ at Risk Maximum Dose if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
java.lang.String	getReferencedDoseReferenceNumber() Retrieves Referenced Dose Reference Number.
java.lang.String	getTargetMaximumDose() Retrieves maximum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
java.lang.String	getTargetMinimumDose() Retrieves minimum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
java.lang.String	getTargetPrescriptionDose() Retrieves prescribed dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
java.lang.String	getTargetUnderdoseVolumeFraction() Retrieves maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose (300A,0027).
void	setConstraintWeight(java.lang.String strConstraintWeight) Sets value that describes relative importance of satisfying constraint, where high values represent more important constraints.
void	setCumulativeDoseReferenceCoefficient(java.lang.String strCumulativeDoseReferenceCoefficient) Sets Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point.
void	setDeliveryMaximumDose(java.lang.String strDeliveryMaximumDose) Sets the maximum dose (in Gy) which can be delivered to the dose reference.
void	setDeliveryWarningDose(java.lang.String strDeliveryWarningDose) Sets the dose (in Gy) which when reached or exceeded should cause some action to be taken.
void	setOrganAtRiskFullVolumeDose(java.lang.String strOrganAtRiskFullVolumeDose) Sets maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
void	setOrganAtRiskLimitDose(java.lang.String strOrganAtRiskLimitDose) Sets maximum permitted dose (in Gy) to any part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
void	setOrganAtRiskMaximumDose(java.lang.String strOrganAtRiskMaximumDose) Sets maximum dose (in Gy) to non-overdosed part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
void	setOrganAtRiskOverdoseVolumeFraction(java.lang.String strOrganAtRiskOverdoseVolumeFraction) Sets maximum permitted fraction (in percent) of Organ at Risk to receive more than the Organ at Risk Maximum Dose if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.
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.
void	setTargetMaximumDose(java.lang.String strTargetMaximumDose) Sets maximum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
void	setTargetMinimumDose(java.lang.String strTargetMinimumDose) Sets minimum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
void	setTargetPrescriptionDose(java.lang.String strTargetPrescriptionDose) Sets prescribed dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.
void	setTargetUnderdoseVolumeFraction(java.lang.String strTargetUnderdoseVolumeFraction) Sets maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose (300A,0027).
boolean	validateForModule() Validates all the attributes in ReferencedDoseReferenceSequenceItem 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

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in ReferencedDoseReferenceSequenceItem that are present in the DataSet.

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - returns validation success as success or Failure

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.

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.

setConstraintWeight

public void setConstraintWeight(java.lang.String strConstraintWeight)

Sets value that describes relative importance of satisfying constraint, where high values represent more important constraints.

Parameters:

strConstraintWeight - String value of Constraint Weight.

getConstraintWeight

public java.lang.String getConstraintWeight()

Retrieves value that describes relative importance of satisfying constraint, where high values represent more important constraints.

Returns:

String - value of Constraint Weight.

setDeliveryWarningDose

public void setDeliveryWarningDose(java.lang.String strDeliveryWarningDose)

Sets the dose (in Gy) which when reached or exceeded should cause some action to be taken.

Parameters:

strDeliveryWarningDose - String value of Delivery Warning Dose.

getDeliveryWarningDose

public java.lang.String getDeliveryWarningDose()

Retrieves the dose (in Gy) which when reached or exceeded should cause some action to be taken.

Returns:

String - value of Delivery Warning Dose.

setDeliveryMaximumDose

public void setDeliveryMaximumDose(java.lang.String strDeliveryMaximumDose)

Sets the maximum dose (in Gy) which can be delivered to the dose reference.

Parameters:

strDeliveryMaximumDose - String value of Delivery Maximum Dose.

getDeliveryMaximumDose

public java.lang.String getDeliveryMaximumDose()

Retrieves the maximum dose (in Gy) which can be delivered to the dose reference.

Returns:

String - value of Delivery Maximum Dose.

setTargetMinimumDose

public void setTargetMinimumDose(java.lang.String strTargetMinimumDose)

Sets minimum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Parameters:

strTargetMinimumDose - String value of Target Minimum Dose.

getTargetMinimumDose

public java.lang.String getTargetMinimumDose()

Retrieves minimum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Returns:

String - value of Target Minimum Dose.

setTargetPrescriptionDose

public void setTargetPrescriptionDose(java.lang.String strTargetPrescriptionDose)

Sets prescribed dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Parameters:

strTargetPrescriptionDose - String value of Target Prescription Dose.

getTargetPrescriptionDose

public java.lang.String getTargetPrescriptionDose()

Retrieves prescribed dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Returns:

String - value of Target Prescription Dose.

setTargetMaximumDose

public void setTargetMaximumDose(java.lang.String strTargetMaximumDose)

Sets maximum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Parameters:

strTargetMaximumDose - String value of Target Maximum Dose.

getTargetMaximumDose

public java.lang.String getTargetMaximumDose()

Retrieves maximum permitted dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET.

Returns:

String - value of Target Maximum Dose.

setTargetUnderdoseVolumeFraction

public void setTargetUnderdoseVolumeFraction(java.lang.String strTargetUnderdoseVolumeFraction)

Sets maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose (300A,0027).

Parameters:

strTargetUnderdoseVolumeFraction - String value of Target Underdose Volume Fraction.

getTargetUnderdoseVolumeFraction

public java.lang.String getTargetUnderdoseVolumeFraction()

Retrieves maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose (300A,0027).

Returns:

String - value of Target Underdose Volume Fraction.

setOrganAtRiskFullVolumeDose

public void setOrganAtRiskFullVolumeDose(java.lang.String strOrganAtRiskFullVolumeDose)

Sets maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Parameters:

strOrganAtRiskFullVolumeDose - String value of Organ at Risk Full-volume Dose.

getOrganAtRiskFullVolumeDose

public java.lang.String getOrganAtRiskFullVolumeDose()

Retrieves maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Returns:

String - value of Organ at Risk Full-volume Dose.

setOrganAtRiskLimitDose

public void setOrganAtRiskLimitDose(java.lang.String strOrganAtRiskLimitDose)

Sets maximum permitted dose (in Gy) to any part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Parameters:

strOrganAtRiskLimitDose - String value of Organ at Organ at Risk Limit Dose.

getOrganAtRiskLimitDose

public java.lang.String getOrganAtRiskLimitDose()

Retrieves maximum permitted dose (in Gy) to any part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Returns:

String - value of Organ at Organ at Risk Limit Dose.

setOrganAtRiskMaximumDose

public void setOrganAtRiskMaximumDose(java.lang.String strOrganAtRiskMaximumDose)

Sets maximum dose (in Gy) to non-overdosed part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Parameters:

strOrganAtRiskMaximumDose - String value of Organ at Organ at Risk Maximum Dose.

getOrganAtRiskMaximumDose

public java.lang.String getOrganAtRiskMaximumDose()

Retrieves maximum dose (in Gy) to non-overdosed part of Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Returns:

String - value of Organ at Organ at Risk Maximum Dose.

setOrganAtRiskOverdoseVolumeFraction

public void setOrganAtRiskOverdoseVolumeFraction(java.lang.String strOrganAtRiskOverdoseVolumeFraction)

Sets maximum permitted fraction (in percent) of Organ at Risk to receive more than the Organ at Risk Maximum Dose if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Parameters:

strOrganAtRiskOverdoseVolumeFraction - String value of Organ at Organ at Risk Overdose Volume Fraction.

getOrganAtRiskOverdoseVolumeFraction

public java.lang.String getOrganAtRiskOverdoseVolumeFraction()

Retrieves maximum permitted fraction (in percent) of Organ at Risk to receive more than the Organ at Risk Maximum Dose if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

Returns:

String - value of Organ at Organ at Risk Overdose Volume Fraction.

setCumulativeDoseReferenceCoefficient

public void setCumulativeDoseReferenceCoefficient(java.lang.String strCumulativeDoseReferenceCoefficient)

Sets Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point.

Parameters:

strCumulativeDoseReferenceCoefficient - String value of Cumulative Dose Reference Coefficient.

getCumulativeDoseReferenceCoefficient

public java.lang.String getCumulativeDoseReferenceCoefficient()

Retrieves Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point.

Returns:

String - value of String value of Cumulative Dose Reference Coefficient.