Package org.dcm4che.typeddicom.dataelements

Class ReferenceDoseType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferenceDoseType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ReferenceDoseType
extends AbstractDataElementWrapper
implements CodeStringWrapper

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

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

  Type of reference dose.

  Defined Terms:

  PER_RADIATION

  Dose values are calculated individually for each referenced RT Radiation SOP Instance.

  NOMINAL

  Dose values are calculated on the Fraction level and assigned to individual RT Radiation SOP Instances without Instance-specific calculations.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

ReferenceDoseType

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

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

Parameters:

attributes - The Attributes object to be wrapped.

ReferenceDoseType

public ReferenceDoseType()

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

Method Details

copy

public ReferenceDoseType copy()

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

Returns:

a new Reference Dose Type which wraps a copy of the Attributes wrapped in this Reference Dose 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.