Package org.dcm4che.typeddicom.dataelements

Class CumulativeDoseReferenceCoefficient

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CumulativeDoseReferenceCoefficient

All Implemented Interfaces:

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

public class CumulativeDoseReferenceCoefficient
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Cumulative Dose Reference Coefficient
Keyword: CumulativeDoseReferenceCoefficient
Tag: (300A,010C)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Control Point Sequence > Referenced Dose Reference Sequence > Cumulative Dose Reference Coefficient
  as follows:
  Attribute Name: Cumulative Dose Reference Coefficient
  Type: 2
  Attribute Description:

  Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point. See DICOM Standard Part 3 - Section C.8.8.14.7.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Referenced Dose Reference Sequence > Cumulative Dose Reference Coefficient
  as follows:
  Attribute Name: Cumulative Dose Reference Coefficient
  Type: 2
  Attribute Description:

  Coefficient used to calculate cumulative dose contribution from this Beam to the referenced Dose Reference at the current Control Point.

  
  
• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Channel Sequence > Brachy Control Point Sequence > Brachy Referenced Dose Reference Sequence > Cumulative Dose Reference Coefficient
  as follows:
  Attribute Name: Cumulative Dose Reference Coefficient
  Type: 1
  Attribute Description:

  Coefficient used to calculate cumulative dose contribution from this Source to the referenced Dose Reference at the current Control Point. See DICOM Standard Part 3 - Section C.8.8.15.11.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CumulativeDoseReferenceCoefficient.Builder<SELF extends CumulativeDoseReferenceCoefficient.Builder<SELF,T>,T extends CumulativeDoseReferenceCoefficient.Holder>
static interface	CumulativeDoseReferenceCoefficient.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Cumulative Dose Reference Coefficient" (see CumulativeDoseReferenceCoefficient)

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.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
CumulativeDoseReferenceCoefficient()	Creates a new Cumulative Dose Reference Coefficient object which wraps a new and empty Attributes object.
CumulativeDoseReferenceCoefficient(org.dcm4che3.data.Attributes attributes)	Creates a new Cumulative Dose Reference Coefficient object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CumulativeDoseReferenceCoefficient	copy()	Returns a new Cumulative Dose Reference Coefficient which wraps a copy of the Attributes wrapped in this Cumulative Dose Reference Coefficient.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

CumulativeDoseReferenceCoefficient

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

Creates a new Cumulative Dose Reference Coefficient object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CumulativeDoseReferenceCoefficient

public CumulativeDoseReferenceCoefficient()

Creates a new Cumulative Dose Reference Coefficient object which wraps a new and empty Attributes object.

Method Details

copy

public CumulativeDoseReferenceCoefficient copy()

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

Returns:

a new Cumulative Dose Reference Coefficient which wraps a copy of the Attributes wrapped in this Cumulative Dose Reference Coefficient.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.