Package org.dcm4che.typeddicom.dataelements

Class DeliveredDistalDepthFraction

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DeliveredDistalDepthFraction

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class DeliveredDistalDepthFraction
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Delivered Distal Depth Fraction
Keyword: DeliveredDistalDepthFraction
Tag: (300A,0507)
Value Representation: FL
Value Multiplicity: 1

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

  Fraction of the value of dose relative to the 100% level defined by Delivered Reference Dose Definition (300A,0511). This determines the Delivered Distal Depth (300A,0508).

  A value of 1.0 refers to 100% of the reference dose level defined by the Delivered Reference Dose Definition (300A,0511).

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DeliveredDistalDepthFraction()	Creates a new Delivered Distal Depth Fraction object which wraps a new and empty Attributes object.
DeliveredDistalDepthFraction(org.dcm4che3.data.Attributes attributes)	Creates a new Delivered Distal Depth Fraction object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DeliveredDistalDepthFraction	copy()	Returns a new Delivered Distal Depth Fraction which wraps a copy of the Attributes wrapped in this Delivered Distal Depth Fraction.
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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

getValueRepresentation

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

DeliveredDistalDepthFraction

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

Creates a new Delivered Distal Depth Fraction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DeliveredDistalDepthFraction

public DeliveredDistalDepthFraction()

Creates a new Delivered Distal Depth Fraction object which wraps a new and empty Attributes object.

Method Details

copy

public DeliveredDistalDepthFraction copy()

Returns a new Delivered Distal Depth Fraction which wraps a copy of the Attributes wrapped in this Delivered Distal Depth Fraction. (see Attributes(Attributes)

Returns:

a new Delivered Distal Depth Fraction which wraps a copy of the Attributes wrapped in this Delivered Distal Depth Fraction.

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.