Package org.dcm4che.typeddicom.dataelements

Class SourceToSurfaceDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SourceToSurfaceDistance

All Implemented Interfaces:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, DecimalStringWrapper, org.dcm4che.typeddicom.valuerepresentations.DoubleDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class SourceToSurfaceDistance
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Source to Surface Distance
Keyword: SourceToSurfaceDistance
Tag: (300A,0130)
Value Representation: DecimalString
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Dose Calibration Conditions Sequence > Source to Surface Distance
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Beam Sequence > Dose Calibration Conditions Sequence > Source to Surface Distance
  as follows:
  Attribute Name: Source to Surface Distance
  Type: 1
  Attribute Description:

  Distance in mm from the radiation source to the phantom surface during calibration.

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

  Source to Patient Surface (skin) distance (mm).

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
SourceToSurfaceDistance()	Creates a new Source to Surface Distance object which wraps a new and empty Attributes object.
SourceToSurfaceDistance(org.dcm4che3.data.Attributes attributes)	Creates a new Source to Surface Distance object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
SourceToSurfaceDistance	copy()	Returns a new Source to Surface Distance which wraps a copy of the Attributes wrapped in this Source to Surface 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, 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.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 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

SourceToSurfaceDistance

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

Creates a new Source to Surface Distance object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

SourceToSurfaceDistance

public SourceToSurfaceDistance()

Creates a new Source to Surface Distance object which wraps a new and empty Attributes object.

Method Detail

copy

public SourceToSurfaceDistance copy()

Returns a new Source to Surface Distance which wraps a copy of the Attributes wrapped in this Source to Surface Distance. (see Attributes(Attributes)

Returns:

a new Source to Surface Distance which wraps a copy of the Attributes wrapped in this Source to Surface 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