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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, FloatingPointDoubleWrapper

public class RTBeamModifierDefinitionDistance
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: RT Beam Modifier Definition Distance
Keyword: RTBeamModifierDefinitionDistance
Tag: (300A,0688)
Value Representation: FloatingPointDouble
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)
static class	RTBeamModifierDefinitionDistance.SimpleHolder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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
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.
java.lang.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.FloatingPointDoubleWrapper

getValueRepresentation

Field Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper