Package org.dcm4che.typeddicom.dataelements

Class DoseSummationType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseSummationType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DoseSummationType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dose Summation Type
Keyword: DoseSummationType
Tag: (3004,000A)
Value Representation: CS
Value Multiplicity: 1

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

  Type of dose summation.

  Defined Terms:

  PLAN

  dose calculated for entire delivery of all fraction groups of RT Plan

  MULTI_PLAN

  dose calculated for entire delivery of 2 or more RT Plans

  FRACTION

  dose calculated for entire delivery of a single Fraction Group within RT Plan

  BEAM

  dose calculated for entire delivery of one or more Beams within RT Plan

  BRACHY

  dose calculated for entire delivery of one or more Brachy Application Setups within RT Plan

  FRACTION_SESSION

  dose calculated for a single session ("fraction") of a single Fraction Group within RT Plan

  BEAM_SESSION

  dose calculated for a single session ("fraction") of one or more Beams within RT Plan

  BRACHY_SESSION

  dose calculated for a single session ("fraction") of one or more Brachy Application Setups within RT Plan

  CONTROL_POINT

  dose calculated for one or more Control Points within a Beam for a single fraction

  RECORD

  dose calculated for RT Beams Treatment Record

  
  

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.CodeStringWrapper

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DoseSummationType()	Creates a new Dose Summation Type object which wraps a new and empty Attributes object.
DoseSummationType(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Summation Type object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

DoseSummationType

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

Creates a new Dose Summation Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseSummationType

public DoseSummationType()

Creates a new Dose Summation Type object which wraps a new and empty Attributes object.

Method Details

copy

public DoseSummationType copy()

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

Returns:

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

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.