Package org.dcm4che.typeddicom.dataelements

Class BeamDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDose

All Implemented Interfaces:

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

public class BeamDose
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Beam Dose
Keyword: BeamDose
Tag: (300A,0084)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Beam Sequence > Beam Dose
  as follows:
  Attribute Name: Beam Dose
  Type: 3
  Attribute Description:

  Dose (in Gy) due to current Beam for one treatment fraction.

  See Note 9.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

BeamDose

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

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

Parameters:

attributes - The Attributes object to be wrapped.

BeamDose

public BeamDose()

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

Method Details

copy

public BeamDose copy()

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

Returns:

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

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.