Package org.dcm4che.typeddicom.dataelements

Class RangeModulatorGatingStartValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangeModulatorGatingStartValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class RangeModulatorGatingStartValue
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Range Modulator Gating Start Value
Keyword: RangeModulatorGatingStartValue
Tag: (300A,0382)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Range Modulator Settings Sequence > Range Modulator Gating Start Value
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Range Modulator Settings Sequence > Range Modulator Gating Start Value
  as follows:
  Attribute Name: Range Modulator Gating Start Value
  Type: 1C
  Attribute Description:

  Start position defines the range modulator position at which the beam is switched on. Required if Range Modulator Type (300A,0348) of the range modulator referenced by Referenced Range Modulator Number (300C,0104) is WHL_MODWEIGHTS or WHL_FIXEDWEIGHTS

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Ion Control Point Verification Sequence > Range Modulator Settings Sequence > Range Modulator Gating Start Value
  as follows:
  Attribute Name: Range Modulator Gating Start Value
  Type:
  Attribute Description:

  Start position, defining the range modulator position at which the beam is switched on.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RangeModulatorGatingStartValue	copy()	Returns a new Range Modulator Gating Start Value which wraps a copy of the Attributes wrapped in this Range Modulator Gating Start Value.
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

RangeModulatorGatingStartValue

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

Creates a new Range Modulator Gating Start Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RangeModulatorGatingStartValue

public RangeModulatorGatingStartValue()

Creates a new Range Modulator Gating Start Value object which wraps a new and empty Attributes object.

Method Details

copy

public RangeModulatorGatingStartValue copy()

Returns a new Range Modulator Gating Start Value which wraps a copy of the Attributes wrapped in this Range Modulator Gating Start Value. (see Attributes(Attributes)

Returns:

a new Range Modulator Gating Start Value which wraps a copy of the Attributes wrapped in this Range Modulator Gating Start Value.

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.