Package org.dcm4che.typeddicom.dataelements

Class DoseReferenceNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseReferenceNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class DoseReferenceNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Dose Reference Number
Keyword: DoseReferenceNumber
Tag: (300A,0012)
Value Representation: IS
Value Multiplicity: 1

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

  Identification number of the Dose Reference. The value of Dose Reference Number (300A,0012) shall be unique within the RT Plan in which it is created.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

Method Summary

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

getInt, setInt

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

DoseReferenceNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DoseReferenceNumber

public DoseReferenceNumber()

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

Method Details

copy

public DoseReferenceNumber copy()

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

Returns:

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

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.