Package org.dcm4che.typeddicom.dataelements

Class TableTopVerticalSetupDisplacement

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TableTopVerticalSetupDisplacement

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class TableTopVerticalSetupDisplacement
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Table Top Vertical Setup Displacement
Keyword: TableTopVerticalSetupDisplacement
Tag: (300A,01D2)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Delivery Instruction Module > Beam Task Sequence > Table Top Vertical Setup Displacement
  as follows:
  Attribute Name: Table Top Vertical Setup Displacement
  Type: 2
  Attribute Description:

  Vertical Displacement in the IEC TABLE TOP coordinate system in mm relative to initial Setup Position, i.e., vertical offset between patient positioning performed using setup and treatment position.

  
  
• Described in the contexts:
  • RT Patient Setup Module > Patient Setup Sequence > Table Top Vertical Setup Displacement
  as follows:
  Attribute Name: Table Top Vertical Setup Displacement
  Type: 3
  Attribute Description:

  Vertical Displacement in IEC TABLE TOP coordinate system (in mm) relative to initial Setup Position, i.e., vertical offset between patient positioning performed using setup and treatment position.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TableTopVerticalSetupDisplacement.Builder<SELF extends TableTopVerticalSetupDisplacement.Builder<SELF,T>,T extends TableTopVerticalSetupDisplacement.Holder>
static interface	TableTopVerticalSetupDisplacement.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Table Top Vertical Setup Displacement" (see TableTopVerticalSetupDisplacement)
static class	TableTopVerticalSetupDisplacement.SimpleHolder

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

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

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.DecimalStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
TableTopVerticalSetupDisplacement()	Creates a new Table Top Vertical Setup Displacement object which wraps a new and empty Attributes object.
TableTopVerticalSetupDisplacement(org.dcm4che3.data.Attributes attributes)	Creates a new Table Top Vertical Setup Displacement object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TableTopVerticalSetupDisplacement	copy()	Returns a new Table Top Vertical Setup Displacement which wraps a copy of the Attributes wrapped in this Table Top Vertical Setup Displacement.
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.DecimalStringWrapper

getValueRepresentation

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.StringDataElementWrapper

getString, setString

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

TableTopVerticalSetupDisplacement

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

Creates a new Table Top Vertical Setup Displacement object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TableTopVerticalSetupDisplacement

public TableTopVerticalSetupDisplacement()

Creates a new Table Top Vertical Setup Displacement object which wraps a new and empty Attributes object.

Method Details

copy

public TableTopVerticalSetupDisplacement copy()

Returns a new Table Top Vertical Setup Displacement which wraps a copy of the Attributes wrapped in this Table Top Vertical Setup Displacement. (see Attributes(Attributes)

Returns:

a new Table Top Vertical Setup Displacement which wraps a copy of the Attributes wrapped in this Table Top Vertical Setup Displacement.

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.