Package org.dcm4che.typeddicom.dataelements

Class TargetPrescriptionDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TargetPrescriptionDose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class TargetPrescriptionDose
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Target Prescription Dose
Keyword: TargetPrescriptionDose
Tag: (300A,0026)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Dose Reference Sequence > Target Prescription Dose
  as follows:
  Attribute Name: Target Prescription Dose
  Type: 3
  Attribute Description:

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

  
  
• Described in the contexts:
  • RT Prescription Module > Dose Reference Sequence > Target Prescription Dose
  as follows:
  Attribute Name: Target Prescription Dose
  Type: 3
  Attribute Description:

  Prescribed dose (in Gy) to Dose Reference if Dose Reference Type (300A,0020) is TARGET.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TargetPrescriptionDose.Builder<SELF extends TargetPrescriptionDose.Builder<SELF,T>,T extends TargetPrescriptionDose.Holder>
static interface	TargetPrescriptionDose.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Target Prescription Dose" (see TargetPrescriptionDose)
static class	TargetPrescriptionDose.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

DecimalStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends DecimalStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PRIVATE_CREATOR	The Private Creator associated with this class.
static final int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
TargetPrescriptionDose()	Creates a new Target Prescription Dose object which wraps a new and empty Attributes object.
TargetPrescriptionDose(org.dcm4che3.data.Attributes attributes)	Creates a new Target Prescription Dose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TargetPrescriptionDose	copy()	Returns a new Target Prescription Dose which wraps a copy of the Attributes wrapped in this Target Prescription Dose.
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.AbstractDataElementWrapper

equals, exists, getValue, hashCode, toString

Methods inherited from class org.dcm4che.typeddicom.AbstractAttributesWrapper

getAttributes

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper

getBytes, getSafeBytes, setBytes

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.DecimalStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper

getDouble, setDouble

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper

getFloat, setFloat

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

getString, setString

Field Details

PRIVATE_CREATOR

public static final String PRIVATE_CREATOR

The Private Creator associated with this class.

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

TargetPrescriptionDose

public TargetPrescriptionDose(org.dcm4che3.data.Attributes attributes)

Creates a new Target Prescription Dose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TargetPrescriptionDose

public TargetPrescriptionDose()

Creates a new Target Prescription Dose object which wraps a new and empty Attributes object.

Method Details

copy

public TargetPrescriptionDose copy()

Returns a new Target Prescription Dose which wraps a copy of the Attributes wrapped in this Target Prescription Dose. (see Attributes(Attributes)

Returns:

a new Target Prescription Dose which wraps a copy of the Attributes wrapped in this Target Prescription Dose.

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.