Package org.dcm4che.typeddicom.dataelements

Class SurfaceEntryPoint

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SurfaceEntryPoint

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, DecimalStringMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementMultiWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementMultiWrapper

public class SurfaceEntryPoint
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringMultiWrapper

Name: Surface Entry Point
Keyword: SurfaceEntryPoint
Tag: (300A,012E)
Value Representation: DecimalString
Value Multiplicity: 3

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Control Point Sequence > Surface Entry Point
  as follows:
  Attribute Name: Surface Entry Point
  Type: 3
  Attribute Description:

  Patient surface entry point coordinates (x,y,z) in the Patient-Based Coordinate System described in DICOM Standard Part 3 - Section C.7.6.2.1.1 (mm).

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Surface Entry Point
  as follows:
  Attribute Name: Surface Entry Point
  Type: 3
  Attribute Description:

  Patient surface entry point coordinates (x,y,z), along the central axis of the beam, in the Patient-Based Coordinate System described in DICOM Standard Part 3 - Section C.7.6.2.1.1 (mm).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SurfaceEntryPoint()	Creates a new Surface Entry Point object which wraps a new and empty Attributes object.
SurfaceEntryPoint(org.dcm4che3.data.Attributes attributes)	Creates a new Surface Entry Point object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SurfaceEntryPoint	copy()	Returns a new Surface Entry Point which wraps a copy of the Attributes wrapped in this Surface Entry Point.
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, getKnownAttributeTags, getUnknownAttributeTags, 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.DecimalStringMultiWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementMultiWrapper

getDouble, getDoubles, setDoubles

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatDataElementMultiWrapper

getFloat, getFloats, setFloats

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.StringDataElementMultiWrapper

getString, getString, getStrings, setStrings

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

SurfaceEntryPoint

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

Creates a new Surface Entry Point object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

SurfaceEntryPoint

public SurfaceEntryPoint()

Creates a new Surface Entry Point object which wraps a new and empty Attributes object.

Method Detail

copy

public SurfaceEntryPoint copy()

Returns a new Surface Entry Point which wraps a copy of the Attributes wrapped in this Surface Entry Point. (see Attributes(Attributes)

Returns:

a new Surface Entry Point which wraps a copy of the Attributes wrapped in this Surface Entry Point.

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