cdac.medinfo.sdk.dcm30_04.baselibs

Class DoseReferenceSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DoseReferenceSequenceItem

All Implemented Interfaces:

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

public class DoseReferenceSequenceItem
extends Item

This Item class provides methods to validate, set and get the attributes of DoseReferenceSequence.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getConstraintWeight() Retrieves Constraint Weight.
java.lang.String	getDeliveryMaximumDose() Retrieves Delivery Maximum Dose.
java.lang.String	getDeliveryWarningDose() Retrieves Delivery Warning Dose.
java.lang.String	getDoseReferenceDescription() Retrieves Dose Reference Description.
java.lang.String	getDoseReferenceNumber() Retrieves Dose Reference Number.
java.lang.String[]	getDoseReferencePointCoordinates() Retrieves Dose Reference Point Coordinates.
java.lang.String	getDoseReferenceStructureType() Retrieves Structure type of Dose Reference.
java.lang.String	getDoseReferenceType() Retrieves Dose Reference Type.
java.lang.String	getDoseReferenceUID() Retrieves Dose Reference UID.
java.lang.String	getNominalPriorDose() Retrieves Nominal Prior Dose.
java.lang.String	getOrganatRiskFull_volumeDose() Retrieves Organ at Risk Full-volume Dose.
java.lang.String	getOrganatRiskLimitDose() Retrieves Organ at Risk Limit Dose.
java.lang.String	getOrganatRiskMaximumDose() Retrieves Organ at Risk Maximum Dose.
java.lang.String	getOrganatRiskOverdoseVolumeFraction() Retrieves Organ at Risk Overdose Volume Fraction.
java.lang.String	getReferencedROINumber() Retrieves Referenced ROI Number.
java.lang.String	getTargetMaximumDose() Retrieves Target Maximum Dose.
java.lang.String	getTargetMinimumDose() Retrieves Target Minimum Dose.
java.lang.String	getTargetPrescriptionDose() Retrieves Target Prescription Dose.
java.lang.String	getTargetUnderdoseVolumeFraction() Retrieves Target Underdose Volume Fraction.
void	setConstraintWeight(java.lang.String strConstraintWeight) Relative importance of satisfying constraint, where high values represent more important constraints.
void	setDeliveryMaximumDose(java.lang.String strDeliveryMaximumDose) The maximum dose (in Gy) which can be delivered to the dose reference Sets Delivery Maximum Dose.Uniquely identifies Delivery Maximum Dose(300A,0023) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setDeliveryWarningDose(java.lang.String strDeliveryWarningDose) The dose (in Gy) which when reached or exceeded should cause some action to be taken.
void	setDoseReferenceDescription(java.lang.String strDoseReferenceDescription) User-defined description of Dose Reference.
void	setDoseReferenceNumber(java.lang.String strDoseReferenceNumber) Identification number of the Dose Reference Sets Dose Reference Number .Uniquely identifies Dose Reference Number(300A,0012) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setDoseReferencePointCoordinates(java.lang.String[] arrstrDoseReferencePointCoordinates) Sets Dose Reference Point Coordinates.Uniquely identifies Dose Reference Point Coordinates(300A,0018) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setDoseReferenceStructureType(EnumDoseReferenceStructureType enumDoseReferenceStructureType) Sets Structure type of Dose Reference.
void	setDoseReferenceType(EnumDoseReferenceType enumDoseReferenceType) Sets Dose Reference Type.Uniquely identifies Dose Reference Type(300A,0020) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setDoseReferenceUID(java.lang.String strDoseReferenceUID) A unique identifier for a Dose Reference that can be used to link the same entity across multiple RT Plan objects.
void	setNominalPriorDose(java.lang.String strNominalPriorDose) Sets Nominal Prior Dose.Uniquely identifies Nominal Prior Dose(300A,001A) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setOrganatRiskFull_volumeDose(java.lang.String strOrganatRiskFull_volumeDose) Maximum dose (in Gy) to entire Dose Reference.
void	setOrganatRiskLimitDose(java.lang.String strOrganatRiskLimitDose) Maximum permitted dose (in Gy) to any part of Dose Reference.
void	setOrganatRiskMaximumDose(java.lang.String strOrganatRiskMaximumDose) Maximum dose (in Gy) to non-overdosed part of Dose Reference.
void	setOrganatRiskOverdoseVolumeFraction(java.lang.String strOrganatRiskOverdoseVolumeFraction) Maximum permitted fraction (in percent) of the Organ at Risk to receive more than the Organ at Risk Maximum Dose.
void	setReferencedROINumber(java.lang.String strReferencedROINumber) Sets Referenced ROI Number.Uniquely identifies Referenced ROI Number(3006,0084) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setTargetMaximumDose(java.lang.String strTargetMaximumDose) Prescribed dose (in Gy) to Dose Reference.
void	setTargetMinimumDose(java.lang.String strTargetMinimumDose) Minimum permitted dose (in Gy) to Dose Reference Sets Target Minimum Dose.Uniquely identifies Target Minimum Dose(300A,0025) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.
void	setTargetPrescriptionDose(java.lang.String strTargetPrescriptionDose) Prescribed dose (in Gy) to Dose Reference.
void	setTargetUnderdoseVolumeFraction(java.lang.String strTargetUnderdoseVolumeFraction) Maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose.
boolean	validateForModule() Validates all the attributes in DoseReferenceSequenceItem 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 DoseReferenceSequenceItem 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 Conditional element fails.

setDoseReferenceNumber

public void setDoseReferenceNumber(java.lang.String strDoseReferenceNumber)

Identification number of the Dose Reference Sets Dose Reference Number .Uniquely identifies Dose Reference Number(300A,0012) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strDoseReferenceNumber - String value of Dose Reference Number.

getDoseReferenceNumber

public java.lang.String getDoseReferenceNumber()

Retrieves Dose Reference Number.

Returns:

String - value of Dose Reference Number.

setDoseReferenceUID

public void setDoseReferenceUID(java.lang.String strDoseReferenceUID)

A unique identifier for a Dose Reference that can be used to link the same entity across multiple RT Plan objects. Sets Dose Reference UID .Uniquely identifies Dose Reference UID(300A,0013) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strDoseReferenceUID - String value of Dose Reference UID.

getDoseReferenceUID

public java.lang.String getDoseReferenceUID()

Retrieves Dose Reference UID.

Returns:

String - value of Dose Reference UID.

setDoseReferenceStructureType

public void setDoseReferenceStructureType(EnumDoseReferenceStructureType enumDoseReferenceStructureType)

Sets Structure type of Dose Reference.

Parameters:

enumDoseReferenceStructureType - Enum value of Dose Reference Structure Type.

getDoseReferenceStructureType

public java.lang.String getDoseReferenceStructureType()

Retrieves Structure type of Dose Reference.

Returns:

String - value of Dose Reference Structure Type.

setDoseReferenceDescription

public void setDoseReferenceDescription(java.lang.String strDoseReferenceDescription)

User-defined description of Dose Reference. Sets Dose Reference Description .Uniquely identifies Dose Reference Description(300A,0016) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strDoseReferenceDescription - String value of User-defined description of Dose Reference.

getDoseReferenceDescription

public java.lang.String getDoseReferenceDescription()

Retrieves Dose Reference Description.

Returns:

String - value of Dose Reference Description.

setReferencedROINumber

public void setReferencedROINumber(java.lang.String strReferencedROINumber)

Sets Referenced ROI Number.Uniquely identifies Referenced ROI Number(3006,0084) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strReferencedROINumber - String value of Referenced ROI Number.

getReferencedROINumber

public java.lang.String getReferencedROINumber()

Retrieves Referenced ROI Number.

Returns:

String - value of Referenced ROI Number.

setDoseReferencePointCoordinates

public void setDoseReferencePointCoordinates(java.lang.String[] arrstrDoseReferencePointCoordinates)

Sets Dose Reference Point Coordinates.Uniquely identifies Dose Reference Point Coordinates(300A,0018) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

arrstrDoseReferencePointCoordinates - String value of Dose Reference Point Coordinates.

getDoseReferencePointCoordinates

public java.lang.String[] getDoseReferencePointCoordinates()

Retrieves Dose Reference Point Coordinates.

Returns:

String - value of Dose Reference Point Coordinates.

setNominalPriorDose

public void setNominalPriorDose(java.lang.String strNominalPriorDose)

Sets Nominal Prior Dose.Uniquely identifies Nominal Prior Dose(300A,001A) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strNominalPriorDose - String value of Nominal Prior Dose.

getNominalPriorDose

public java.lang.String getNominalPriorDose()

Retrieves Nominal Prior Dose.

Returns:

String - value of Nominal Prior Dose.

setDoseReferenceType

public void setDoseReferenceType(EnumDoseReferenceType enumDoseReferenceType)

Sets Dose Reference Type.Uniquely identifies Dose Reference Type(300A,0020) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

enumDoseReferenceType - Enum value of Dose Reference Type.

getDoseReferenceType

public java.lang.String getDoseReferenceType()

Retrieves Dose Reference Type.

Returns:

String - value of Dose Reference Type.

setConstraintWeight

public void setConstraintWeight(java.lang.String strConstraintWeight)

Relative importance of satisfying constraint, where high values represent more important constraints. Sets Constraint Weight.Uniquely identifies Constraint Weight(300A,0021) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strConstraintWeight - String value of Constraint Weight.

getConstraintWeight

public java.lang.String getConstraintWeight()

Retrieves Constraint Weight.

Returns:

String - value of Constraint Weight.

setDeliveryWarningDose

public void setDeliveryWarningDose(java.lang.String strDeliveryWarningDose)

The dose (in Gy) which when reached or exceeded should cause some action to be taken. Sets Delivery Warning Dose.Uniquely identifies Delivery Warning Dose(300A,0022) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strDeliveryWarningDose - String value of Delivery Warning Dose.

getDeliveryWarningDose

public java.lang.String getDeliveryWarningDose()

Retrieves Delivery Warning Dose.

Returns:

String value of Delivery Warning Dose.

setDeliveryMaximumDose

public void setDeliveryMaximumDose(java.lang.String strDeliveryMaximumDose)

The maximum dose (in Gy) which can be delivered to the dose reference Sets Delivery Maximum Dose.Uniquely identifies Delivery Maximum Dose(300A,0023) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strDeliveryMaximumDose - String value of Delivery Maximum Dose.

getDeliveryMaximumDose

public java.lang.String getDeliveryMaximumDose()

Retrieves Delivery Maximum Dose.

Returns:

String - value of Delivery Maximum Dose.

setTargetMinimumDose

public void setTargetMinimumDose(java.lang.String strTargetMinimumDose)

Minimum permitted dose (in Gy) to Dose Reference Sets Target Minimum Dose.Uniquely identifies Target Minimum Dose(300A,0025) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strTargetMinimumDose - String value of Target Minimum Dose.

getTargetMinimumDose

public java.lang.String getTargetMinimumDose()

Retrieves Target Minimum Dose.

Returns:

String - value of Target Minimum Dose.

setTargetPrescriptionDose

public void setTargetPrescriptionDose(java.lang.String strTargetPrescriptionDose)

Prescribed dose (in Gy) to Dose Reference. Sets Target Prescription Dose.Uniquely identifies Target Prescription Dose(300A,0026) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strTargetPrescriptionDose - String value of Target Prescription Dose.

getTargetPrescriptionDose

public java.lang.String getTargetPrescriptionDose()

Retrieves Target Prescription Dose.

Returns:

String - value of Target Prescription Dose.

setTargetMaximumDose

public void setTargetMaximumDose(java.lang.String strTargetMaximumDose)

Prescribed dose (in Gy) to Dose Reference. Sets Target Maximum Dose.Uniquely identifies Target Maximum Dose(300A,0027) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strTargetMaximumDose - String value of Target Maximum Dose.

getTargetMaximumDose

public java.lang.String getTargetMaximumDose()

Retrieves Target Maximum Dose.

Returns:

String - value of Target Maximum Dose.

setTargetUnderdoseVolumeFraction

public void setTargetUnderdoseVolumeFraction(java.lang.String strTargetUnderdoseVolumeFraction)

Maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose. Sets Target Underdose Volume Fraction.Uniquely identifies Target Underdose Volume Fraction(300A,0028) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strTargetUnderdoseVolumeFraction - String value of Target Underdose Volume Fraction.

getTargetUnderdoseVolumeFraction

public java.lang.String getTargetUnderdoseVolumeFraction()

Retrieves Target Underdose Volume Fraction.

Returns:

String - value of Target Underdose Volume Fraction.

setOrganatRiskFull_volumeDose

public void setOrganatRiskFull_volumeDose(java.lang.String strOrganatRiskFull_volumeDose)

Maximum dose (in Gy) to entire Dose Reference. Sets Organ at Risk Full-volume Dose.Uniquely identifies Organ at Risk Full-volume Dose(300A,002A) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

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

getOrganatRiskFull_volumeDose

public java.lang.String getOrganatRiskFull_volumeDose()

Retrieves Organ at Risk Full-volume Dose.

Returns:

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

setOrganatRiskLimitDose

public void setOrganatRiskLimitDose(java.lang.String strOrganatRiskLimitDose)

Maximum permitted dose (in Gy) to any part of Dose Reference. Sets Organ at Risk Limit Dose.Uniquely identifies Organ at Risk Limit Dose(300A,002B) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strOrganatRiskLimitDose - String value of Organ at Risk Limit Dose.

getOrganatRiskLimitDose

public java.lang.String getOrganatRiskLimitDose()

Retrieves Organ at Risk Limit Dose.

Returns:

String - value of Organ at Risk Limit Dose.

setOrganatRiskMaximumDose

public void setOrganatRiskMaximumDose(java.lang.String strOrganatRiskMaximumDose)

Maximum dose (in Gy) to non-overdosed part of Dose Reference. Sets Organ at Risk Maximum Dose.Uniquely identifiesOrgan at Risk Maximum Dose(300A,002C) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

strOrganatRiskMaximumDose - String value of Organ at Risk Maximum Dose.

getOrganatRiskMaximumDose

public java.lang.String getOrganatRiskMaximumDose()

Retrieves Organ at Risk Maximum Dose.

Returns:

String - value of Organ at Risk Maximum Dose.

setOrganatRiskOverdoseVolumeFraction

public void setOrganatRiskOverdoseVolumeFraction(java.lang.String strOrganatRiskOverdoseVolumeFraction)

Maximum permitted fraction (in percent) of the Organ at Risk to receive more than the Organ at Risk Maximum Dose. Sets Organ at Risk Overdose Volume Fraction.Uniquely identifies Organ at Risk Overdose Volume Fraction(300A,002D) in Dose Reference Sequence (300A,0010) in RT Prescription Module of RT Plan IOD.

Parameters:

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

getOrganatRiskOverdoseVolumeFraction

public java.lang.String getOrganatRiskOverdoseVolumeFraction()

Retrieves Organ at Risk Overdose Volume Fraction.

Returns:

String - value of Organ at Risk Overdose Volume Fraction.