Package org.dcm4che.typeddicom.dataelements

Class RTBeamModifierDefinitionDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTBeamModifierDefinitionDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class RTBeamModifierDefinitionDistance
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: RT Beam Modifier Definition Distance
Keyword: RTBeamModifierDefinitionDistance
Tag: (300A,0688)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • RT Delivery Device Common Module > RT Beam Modifier Definition Distance
  as follows:
  Attribute Name: RT Beam Modifier Definition Distance
  Type: 1
  Attribute Description:

  Absolute distance in mm along the z-axis of the Base Beam Modifier Coordinate System from the reference location as specified by RT Device Distance Reference Location Code Sequence (300A,0659) to the Base Beam Modifier Definition Plane.

  The value shall be greater than or equal to zero.

  See DICOM Standard Part 3 - Section C.36.1.1.9.

  
  

Nested Class Summary

Nested Classes

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

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

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

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
RTBeamModifierDefinitionDistance()	Creates a new RT Beam Modifier Definition Distance object which wraps a new and empty Attributes object.
RTBeamModifierDefinitionDistance(org.dcm4che3.data.Attributes attributes)	Creates a new RT Beam Modifier Definition Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTBeamModifierDefinitionDistance	copy()	Returns a new RT Beam Modifier Definition Distance which wraps a copy of the Attributes wrapped in this RT Beam Modifier Definition Distance.
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.DoubleDataElementWrapper

getDouble, setDouble

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

getFloat, setFloat

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

RTBeamModifierDefinitionDistance

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

Creates a new RT Beam Modifier Definition Distance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTBeamModifierDefinitionDistance

public RTBeamModifierDefinitionDistance()

Creates a new RT Beam Modifier Definition Distance object which wraps a new and empty Attributes object.

Method Details

copy

public RTBeamModifierDefinitionDistance copy()

Returns a new RT Beam Modifier Definition Distance which wraps a copy of the Attributes wrapped in this RT Beam Modifier Definition Distance. (see Attributes(Attributes)

Returns:

a new RT Beam Modifier Definition Distance which wraps a copy of the Attributes wrapped in this RT Beam Modifier Definition Distance.

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.