Package org.dcm4che.typeddicom.dataelements

Class SourceToReferenceObjectDistance

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.SourceToReferenceObjectDistance

All Implemented Interfaces:

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

public class SourceToReferenceObjectDistance
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Source to Reference Object Distance
Keyword: SourceToReferenceObjectDistance
Tag: (3002,0028)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Image Module > Source to Reference Object Distance
  as follows:
  Attribute Name: Source to Reference Object Distance
  Type: 3
  Attribute Description:

  Source to reference object distance (in mm), as used for magnification calculation of RADIOGRAPH and SIMULATOR images.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SourceToReferenceObjectDistance.Builder<SELF extends SourceToReferenceObjectDistance.Builder<SELF,T>,T extends SourceToReferenceObjectDistance.Holder>
static interface	SourceToReferenceObjectDistance.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Source to Reference Object Distance" (see SourceToReferenceObjectDistance)
static class	SourceToReferenceObjectDistance.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
SourceToReferenceObjectDistance()	Creates a new Source to Reference Object Distance object which wraps a new and empty Attributes object.
SourceToReferenceObjectDistance(org.dcm4che3.data.Attributes attributes)	Creates a new Source to Reference Object Distance object which wraps the provided attributes.

Method Summary

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

SourceToReferenceObjectDistance

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

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

Parameters:

attributes - The Attributes object to be wrapped.

SourceToReferenceObjectDistance

public SourceToReferenceObjectDistance()

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

Method Details

copy

public SourceToReferenceObjectDistance copy()

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

Returns:

a new Source to Reference Object Distance which wraps a copy of the Attributes wrapped in this Source to Reference Object Distance.

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.