Package org.dcm4che.typeddicom.dataelements

Class CalculatedDoseReferenceNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CalculatedDoseReferenceNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class CalculatedDoseReferenceNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Calculated Dose Reference Number
Keyword: CalculatedDoseReferenceNumber
Tag: (3008,0072)
Value Representation: IS
Value Multiplicity: 1

• Described in the contexts:
  • Calculated Dose Reference Record Module > Calculated Dose Reference Sequence > Calculated Dose Reference Number
  as follows:
  Attribute Name: Calculated Dose Reference Number
  Type: 1C
  Attribute Description:

  Unique identifier of dose reference point within RT Treatment Record IOD. Required only if Referenced Dose Reference Number (300C,0051) is not present. It shall not be present otherwise.

  
  

Nested Class Summary

Nested Classes

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

CalculatedDoseReferenceNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CalculatedDoseReferenceNumber

public CalculatedDoseReferenceNumber()

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

Method Details

copy

public CalculatedDoseReferenceNumber copy()

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

Returns:

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

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.