Package org.dcm4che.typeddicom.dataelements

Class DoseValue

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseValue

All Implemented Interfaces:

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

public class DoseValue
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Dose Value
Keyword: DoseValue
Tag: (3004,0012)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose ROI Module > RT Dose ROI Sequence > Dose Value
  as follows:
  Attribute Name: Dose Value
  Type: 1
  Attribute Description:

  Dose value for ROI, in units defined by Dose Units (3004,0002). See DICOM Standard Part 3 - Section C.8.8.7.3.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

DoseValue

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DoseValue

public DoseValue()

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

Method Details

copy

public DoseValue copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.