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:

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 DoseValue
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Dose Value
Keyword: DoseValue
Tag: (3004,0012)
Value Representation: DecimalString
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)

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

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 Detail

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.

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