Package org.dcm4che.typeddicom.dataelements

Class TotalReferenceAirKerma

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TotalReferenceAirKerma

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

Name: Total Reference Air Kerma
Keyword: TotalReferenceAirKerma
Tag: (300A,0250)
Value Representation: DecimalString
Value Multiplicity: 1

• Described in the contexts:
  • RT Brachy Application Setups Module > Application Setup Sequence > Total Reference Air Kerma
  as follows:
  Attribute Name: Total Reference Air Kerma
  Type: 1
  Attribute Description:

  Total Reference Air Kerma for current Application Setup, i.e., the product of Air Kerma Rate of all Sources in all Channels with their respective Channel Times (µGy at 1 m). Value shall be zero for non-gamma sources.

  
  
• Described in the contexts:
  • RT Brachy Session Record Module > Treatment Session Application Setup Sequence > Total Reference Air Kerma
  as follows:
  Attribute Name: Total Reference Air Kerma
  Type: 1
  Attribute Description:

  Total Reference Air Kerma for current Application Setup, i.e., the sum of the products of the Air Kerma Rates of each Source in each Channel with its respective Channel Time (µGy at 1 m). Value shall be zero for non-gamma sources.

  
  

Nested Class Summary

Nested Classes

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

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
TotalReferenceAirKerma()	Creates a new Total Reference Air Kerma object which wraps a new and empty Attributes object.
TotalReferenceAirKerma(org.dcm4che3.data.Attributes attributes)	Creates a new Total Reference Air Kerma object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
TotalReferenceAirKerma	copy()	Returns a new Total Reference Air Kerma which wraps a copy of the Attributes wrapped in this Total Reference Air Kerma.
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, 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

TotalReferenceAirKerma

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

Creates a new Total Reference Air Kerma object which wraps the provided attributes.

Parameters:

attributes - the Attributes object to be wrapped.

TotalReferenceAirKerma

public TotalReferenceAirKerma()

Creates a new Total Reference Air Kerma object which wraps a new and empty Attributes object.

Method Detail

copy

public TotalReferenceAirKerma copy()

Returns a new Total Reference Air Kerma which wraps a copy of the Attributes wrapped in this Total Reference Air Kerma. (see Attributes(Attributes)

Returns:

a new Total Reference Air Kerma which wraps a copy of the Attributes wrapped in this Total Reference Air Kerma.

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