Package org.dcm4che.typeddicom.dataelements

Class ReferencedDoseReferenceUID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferencedDoseReferenceUID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, StringDataElementWrapper, UniqueIdentifierUIDWrapper

public class ReferencedDoseReferenceUID
extends AbstractDataElementWrapper
implements UniqueIdentifierUIDWrapper

Name: Referenced Dose Reference UID
Keyword: ReferencedDoseReferenceUID
Tag: (300A,0083)
Value Representation: UI
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Brachy Application Setup Sequence > Referenced Dose Reference UID
  as follows:
  Attribute Name: Referenced Dose Reference UID
  Type: 3
  Attribute Description:

  Identifies the Dose Reference specified by Dose Reference UID (300A,0013) in the Dose Reference Sequence (300A,0010) in the RT Prescription Module that specifies the primary target for the current Brachy Application Setup.

  If present, shall have a value that is present in the Dose Reference Sequence (300A,0010).

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

  Identifies the Dose Reference specified by Dose Reference UID (300A,0013) in the Dose Reference Sequence (300A,0010) in the RT Prescription Module which specifies the primary target for the current Beam.

  If present shall have a value that is present in the Dose Reference Sequence.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferencedDoseReferenceUID.Builder<SELF extends ReferencedDoseReferenceUID.Builder<SELF,T>,T extends ReferencedDoseReferenceUID.Holder>
static interface	ReferencedDoseReferenceUID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Dose Reference UID" (see ReferencedDoseReferenceUID)
static class	ReferencedDoseReferenceUID.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 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
ReferencedDoseReferenceUID()	Creates a new Referenced Dose Reference UID object which wraps a new and empty Attributes object.
ReferencedDoseReferenceUID(org.dcm4che3.data.Attributes attributes)	Creates a new Referenced Dose Reference UID object which wraps the provided attributes.

Method Summary

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

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

getString, setString

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

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

ReferencedDoseReferenceUID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ReferencedDoseReferenceUID

public ReferencedDoseReferenceUID()

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

Method Details

copy

public ReferencedDoseReferenceUID copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.