Package org.dcm4che.typeddicom.dataelements

Class DoseReferenceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseReferenceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class DoseReferenceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Dose Reference UID
Keyword: DoseReferenceUID
Tag: (300A,0013)
Value Representation: UI
Value Multiplicity: 1

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

  A unique identifier for a Dose Reference that can be used to link the same entity across multiple RT Plan objects.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DoseReferenceUID()	Creates a new Dose Reference UID object which wraps a new and empty Attributes object.
DoseReferenceUID(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Reference UID object which wraps the provided attributes.

Method Summary

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

getString, setString

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

getValueRepresentation

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

DoseReferenceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DoseReferenceUID

public DoseReferenceUID()

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

Method Details

copy

public DoseReferenceUID copy()

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

Returns:

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

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.