Package org.dcm4che.typeddicom.dataelements

Class NominalPriorDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalPriorDose

All Implemented Interfaces:

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

public class NominalPriorDose
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Nominal Prior Dose
Keyword: NominalPriorDose
Tag: (300A,001A)
Value Representation: DS
Value Multiplicity: 1

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

  Dose (in Gy) from prior treatment to this Dose Reference (e.g., from a previous course of treatment).

  
  

Nested Class Summary

Nested Classes

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

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 int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
NominalPriorDose()	Creates a new Nominal Prior Dose object which wraps a new and empty Attributes object.
NominalPriorDose(org.dcm4che3.data.Attributes attributes)	Creates a new Nominal Prior Dose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
NominalPriorDose	copy()	Returns a new Nominal Prior Dose which wraps a copy of the Attributes wrapped in this Nominal Prior Dose.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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.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

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

NominalPriorDose

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

Creates a new Nominal Prior Dose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

NominalPriorDose

public NominalPriorDose()

Creates a new Nominal Prior Dose object which wraps a new and empty Attributes object.

Method Details

copy

public NominalPriorDose copy()

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

Returns:

a new Nominal Prior Dose which wraps a copy of the Attributes wrapped in this Nominal Prior Dose.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.