Package org.dcm4che.typeddicom.dataelements

Class CompensatorBasePlaneOffset

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorBasePlaneOffset

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class CompensatorBasePlaneOffset
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: Compensator Base Plane Offset
Keyword: CompensatorBasePlaneOffset
Tag: (300A,0666)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • Compensators Definition Macro > Compensator Definition Sequence > Compensator Base Plane Offset
  as follows:
  Attribute Name: Compensator Base Plane Offset
  Type: 1C
  Attribute Description:

  The distance in mm between the mounting plane and the base plane of the compensator.

  The value shall be positive when the base plane is farther away from the reference location (as specified by RT Device Distance Reference Location Code Sequence (300A,0659) ) than the mounting plane.

  Required if RT Radiation Physical and Geometric Content Detail Flag (300A,0638) equals FULL. May be present otherwise.

  See DICOM Standard Part 3 - Section C.36.2.2.12.1.2.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompensatorBasePlaneOffset.Builder<SELF extends CompensatorBasePlaneOffset.Builder<SELF,T>,T extends CompensatorBasePlaneOffset.Holder>
static interface	CompensatorBasePlaneOffset.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Compensator Base Plane Offset" (see CompensatorBasePlaneOffset)
static class	CompensatorBasePlaneOffset.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 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.FloatingPointDoubleWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
CompensatorBasePlaneOffset()	Creates a new Compensator Base Plane Offset object which wraps a new and empty Attributes object.
CompensatorBasePlaneOffset(org.dcm4che3.data.Attributes attributes)	Creates a new Compensator Base Plane Offset object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CompensatorBasePlaneOffset	copy()	Returns a new Compensator Base Plane Offset which wraps a copy of the Attributes wrapped in this Compensator Base Plane Offset.
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 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

CompensatorBasePlaneOffset

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

Creates a new Compensator Base Plane Offset object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorBasePlaneOffset

public CompensatorBasePlaneOffset()

Creates a new Compensator Base Plane Offset object which wraps a new and empty Attributes object.

Method Details

copy

public CompensatorBasePlaneOffset copy()

Returns a new Compensator Base Plane Offset which wraps a copy of the Attributes wrapped in this Compensator Base Plane Offset. (see Attributes(Attributes)

Returns:

a new Compensator Base Plane Offset which wraps a copy of the Attributes wrapped in this Compensator Base Plane Offset.

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.