Package org.dcm4che.typeddicom.dataelements

Class DoseReferenceDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseReferenceDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongStringWrapper, StringDataElementWrapper

public class DoseReferenceDescription
extends AbstractDataElementWrapper
implements LongStringWrapper

Name: Dose Reference Description
Keyword: DoseReferenceDescription
Tag: (300A,0016)
Value Representation: LO
Value Multiplicity: 1

• Described in the contexts:
  • RT Treatment Summary Record Module > Treatment Summary Calculated Dose Reference Sequence > Dose Reference Description
  • RT Treatment Summary Record Module > Treatment Summary Measured Dose Reference Sequence > Dose Reference Description
  • RT Prescription Module > Dose Reference Sequence > Dose Reference Description
  as follows:
  Attribute Name: Dose Reference Description
  Type: 3
  Attribute Description:

  User-defined description of Dose Reference.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
DoseReferenceDescription()	Creates a new Dose Reference Description object which wraps a new and empty Attributes object.
DoseReferenceDescription(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Reference Description object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DoseReferenceDescription	copy()	Returns a new Dose Reference Description which wraps a copy of the Attributes wrapped in this Dose Reference Description.
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.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

DoseReferenceDescription

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

Creates a new Dose Reference Description object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseReferenceDescription

public DoseReferenceDescription()

Creates a new Dose Reference Description object which wraps a new and empty Attributes object.

Method Details

copy

public DoseReferenceDescription copy()

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

Returns:

a new Dose Reference Description which wraps a copy of the Attributes wrapped in this Dose Reference Description.

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.