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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper, IntegerStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class DoseReferenceNumber
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Dose Reference Number
Keyword: DoseReferenceNumber
Tag: (300A,0012)
Value Representation: IntegerString
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 org.dcm4che.typeddicom.Builder<B,? extends org.dcm4che.typeddicom.AttributesWrapper>,D extends IntegerStringWrapper>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static int	TAG	The DICOM Tag associated with this class.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

VALUE_REPRESENTATION

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.
java.lang.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, getKnownAttributeTags, getUnknownAttributeTags, 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.IntegerStringWrapper

getValueRepresentation

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

getString, setString

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper