Package org.dcm4che.typeddicom.dataelements

Class DeliveredReferenceDoseDefinition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DeliveredReferenceDoseDefinition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DeliveredReferenceDoseDefinition
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Delivered Reference Dose Definition
Keyword: DeliveredReferenceDoseDefinition
Tag: (300A,0511)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Delivered Depth Dose Parameters Sequence > Delivered Reference Dose Definition
  as follows:
  Attribute Name: Delivered Reference Dose Definition
  Type: 1
  Attribute Description:

  Definition of the 100% delivered reference dose level.

  Defined Terms:

  HIGHEST

  MAXIMUM

  CENTER

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

DeliveredReferenceDoseDefinition

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DeliveredReferenceDoseDefinition

public DeliveredReferenceDoseDefinition()

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

Method Details

copy

public DeliveredReferenceDoseDefinition copy()

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

Returns:

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

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.