Package org.dcm4che.typeddicom.dataelements

Class SnoutPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SnoutPosition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class SnoutPosition
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Snout Position
Keyword: SnoutPosition
Tag: (300A,030D)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Ion Control Point Verification Sequence > Snout Position
  as follows:
  Attribute Name: Snout Position
  Type:
  Attribute Description:

  Axial position in mm of the snout, measured from isocenter to the downstream side of the snout (without consideration of variable length elements such as blocks, MLC and/or compensators).

  
  
• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Snout Position
  as follows:
  Attribute Name: Snout Position
  Type: 2C
  Attribute Description:

  Axial position of the snout (in mm) measured from isocenter to the downstream side of the snout (without consideration of variable length elements such as blocks, MLC and/or compensators). Required for Control Point 0 of Ion Control Point Delivery Sequence (3008,0041) or if Snout Position changes during beam administration.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Snout Position
  as follows:
  Attribute Name: Snout Position
  Type: 2C
  Attribute Description:

  Axial position of the snout (in mm) measured from isocenter to the downstream side of the snout (without consideration of variable length elements such as blocks, MLC and/or compensators). Required for first Item in Control Point Sequence, or if Snout Position changes during Beam.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SnoutPosition.Builder<SELF extends SnoutPosition.Builder<SELF,T>,T extends SnoutPosition.Holder>
static interface	SnoutPosition.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Snout Position" (see SnoutPosition)
static class	SnoutPosition.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SnoutPosition()	Creates a new Snout Position object which wraps a new and empty Attributes object.
SnoutPosition(org.dcm4che3.data.Attributes attributes)	Creates a new Snout Position object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SnoutPosition	copy()	Returns a new Snout Position which wraps a copy of the Attributes wrapped in this Snout Position.
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.FloatingPointSingleWrapper

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

SnoutPosition

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

Creates a new Snout Position object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

SnoutPosition

public SnoutPosition()

Creates a new Snout Position object which wraps a new and empty Attributes object.

Method Details

copy

public SnoutPosition copy()

Returns a new Snout Position which wraps a copy of the Attributes wrapped in this Snout Position. (see Attributes(Attributes)

Returns:

a new Snout Position which wraps a copy of the Attributes wrapped in this Snout Position.

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.