Package org.dcm4che.typeddicom.dataelements

Class CorrectionValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CorrectionValue

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointSingleWrapper

public class CorrectionValue
extends AbstractDataElementWrapper
implements FloatingPointSingleWrapper

Name: Correction Value
Keyword: CorrectionValue
Tag: (3008,006A)
Value Representation: FL
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Corrected Parameter Sequence > Correction Value
  as follows:
  Attribute Name: Correction Value
  Type: 1
  Attribute Description:

  The value that was added the value referenced by the Parameter Sequence Pointer (3008,0061), Parameter Item Index (3008,0063) and Parameter Pointer (3008,0065).

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Corrected Parameter Sequence > Correction Value
  as follows:
  Attribute Name: Correction Value
  Type: 1
  Attribute Description:

  The value applied to the Attribute that was referenced by the Parameter Sequence Pointer (3008,0061), Parameter Item Index (3008,0063) and Parameter Pointer (3008,0065).

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

CorrectionValue

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

Creates a new Correction Value object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CorrectionValue

public CorrectionValue()

Creates a new Correction Value object which wraps a new and empty Attributes object.

Method Details

copy

public CorrectionValue copy()

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

Returns:

a new Correction Value which wraps a copy of the Attributes wrapped in this Correction Value.

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.