Package org.dcm4che.typeddicom.dataelements

Class NominalRangeModulatedRegionDepths

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalRangeModulatedRegionDepths

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementMultiWrapper, FloatDataElementMultiWrapper, FloatingPointSingleMultiWrapper

public class NominalRangeModulatedRegionDepths
extends AbstractDataElementWrapper
implements FloatingPointSingleMultiWrapper

Name: Nominal Range Modulated Region Depths
Keyword: NominalRangeModulatedRegionDepths
Tag: (300A,0504)
Value Representation: FL
Value Multiplicity: 2

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Depth Dose Parameters Sequence > Nominal Range Modulated Region Depths
  as follows:
  Attribute Name: Nominal Range Modulated Region Depths
  Type: 1C
  Attribute Description:

  The depths of the proximal and distal limits of the range modulated region in water.

  Contains two values (in mm). The first value defines the depth of the proximal limit. The second value defines the depth of the distal limit.

  Required if Reference Dose Definition (300A,0512) has the value CENTER.

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NominalRangeModulatedRegionDepths.Builder<SELF extends NominalRangeModulatedRegionDepths.Builder<SELF,T>,T extends NominalRangeModulatedRegionDepths.Holder>
static interface	NominalRangeModulatedRegionDepths.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Nominal Range Modulated Region Depths" (see NominalRangeModulatedRegionDepths)
static class	NominalRangeModulatedRegionDepths.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
NominalRangeModulatedRegionDepths()	Creates a new Nominal Range Modulated Region Depths object which wraps a new and empty Attributes object.
NominalRangeModulatedRegionDepths(org.dcm4che3.data.Attributes attributes)	Creates a new Nominal Range Modulated Region Depths object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
NominalRangeModulatedRegionDepths	copy()	Returns a new Nominal Range Modulated Region Depths which wraps a copy of the Attributes wrapped in this Nominal Range Modulated Region Depths.
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.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

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

getFloat, getFloats, setFloats

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

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

NominalRangeModulatedRegionDepths

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

Creates a new Nominal Range Modulated Region Depths object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

NominalRangeModulatedRegionDepths

public NominalRangeModulatedRegionDepths()

Creates a new Nominal Range Modulated Region Depths object which wraps a new and empty Attributes object.

Method Details

copy

public NominalRangeModulatedRegionDepths copy()

Returns a new Nominal Range Modulated Region Depths which wraps a copy of the Attributes wrapped in this Nominal Range Modulated Region Depths. (see Attributes(Attributes)

Returns:

a new Nominal Range Modulated Region Depths which wraps a copy of the Attributes wrapped in this Nominal Range Modulated Region Depths.

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.