Package org.dcm4che.typeddicom.dataelements

Class RTBeamLimitingDeviceProximalDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RTBeamLimitingDeviceProximalDistance

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class RTBeamLimitingDeviceProximalDistance
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: RT Beam Limiting Device Proximal Distance
Keyword: RTBeamLimitingDeviceProximalDistance
Tag: (300A,0642)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • RT Beam Limiting Devices Definition Macro > RT Beam Limiting Device Definition Sequence > RT Beam Limiting Device Proximal Distance
  as follows:
  Attribute Name: RT Beam Limiting Device Proximal Distance
  Type: 2
  Attribute Description:

  Distance in mm from the reference location as specified by RT Device Distance Reference Location Code Sequence (300A,0659) to the proximal end of beam limiting device (collimator) along the beam axis.

  See DICOM Standard Part 3 - Section C.36.2.2.8.1.4.

  
  

Nested Class Summary

Nested Classes

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

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.

Fields inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatingPointDoubleWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
RTBeamLimitingDeviceProximalDistance()	Creates a new RT Beam Limiting Device Proximal Distance object which wraps a new and empty Attributes object.
RTBeamLimitingDeviceProximalDistance(org.dcm4che3.data.Attributes attributes)	Creates a new RT Beam Limiting Device Proximal Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RTBeamLimitingDeviceProximalDistance	copy()	Returns a new RT Beam Limiting Device Proximal Distance which wraps a copy of the Attributes wrapped in this RT Beam Limiting Device Proximal Distance.
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, getPrivateCreator, 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.FloatingPointDoubleWrapper

getValueRepresentation

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

RTBeamLimitingDeviceProximalDistance

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

Creates a new RT Beam Limiting Device Proximal Distance object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RTBeamLimitingDeviceProximalDistance

public RTBeamLimitingDeviceProximalDistance()

Creates a new RT Beam Limiting Device Proximal Distance object which wraps a new and empty Attributes object.

Method Details

copy

public RTBeamLimitingDeviceProximalDistance copy()

Returns a new RT Beam Limiting Device Proximal Distance which wraps a copy of the Attributes wrapped in this RT Beam Limiting Device Proximal Distance. (see Attributes(Attributes)

Returns:

a new RT Beam Limiting Device Proximal Distance which wraps a copy of the Attributes wrapped in this RT Beam Limiting Device Proximal Distance.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.