Package org.dcm4che.typeddicom.dataelements

Class DoseReferenceType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseReferenceType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DoseReferenceType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dose Reference Type
Keyword: DoseReferenceType
Tag: (300A,0020)
Value Representation: CS
Value Multiplicity: 1

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

  Type of Dose Reference.

  Defined Terms:

  TARGET

  treatment target (corresponding to GTV, PTV, or CTV in DICOM Standard Part 3 - biblio_ICRU50)

  ORGAN_AT_RISK

  Organ at Risk (as defined in DICOM Standard Part 3 - biblio_ICRU50)

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

DoseReferenceType

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DoseReferenceType

public DoseReferenceType()

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

Method Details

copy

public DoseReferenceType copy()

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

Returns:

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

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.