Package org.dcm4che.typeddicom.dataelements

Class CumulativeMetersetWeight

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CumulativeMetersetWeight

All Implemented Interfaces:

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

public class CumulativeMetersetWeight
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Cumulative Meterset Weight
Keyword: CumulativeMetersetWeight
Tag: (300A,0134)
Value Representation: DS
Value Multiplicity: 1

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

  The cumulative Meterset weight value, at which the beam dose point geometrical parameters apply.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Control Point Sequence > Cumulative Meterset Weight
  as follows:
  Attribute Name: Cumulative Meterset Weight
  Type: 2
  Attribute Description:

  Cumulative weight to current control point. Cumulative Meterset Weight for the first Item in Control Point Sequence shall always be zero. Cumulative Meterset Weight for the final Item in Control Point Sequence shall always be equal to Final Cumulative Meterset Weight. See DICOM Standard Part 3 - Section C.8.8.14.1.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Cumulative Meterset Weight
  as follows:
  Attribute Name: Cumulative Meterset Weight
  Type: 2
  Attribute Description:

  Cumulative weight to current control point. Cumulative Meterset Weight for the first Item in Control Point Sequence shall always be zero. Cumulative Meterset Weight for the final Item in Ion Control Point Sequence shall always be equal to Final Cumulative Meterset Weight.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

CumulativeMetersetWeight

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

Creates a new Cumulative Meterset Weight object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CumulativeMetersetWeight

public CumulativeMetersetWeight()

Creates a new Cumulative Meterset Weight object which wraps a new and empty Attributes object.

Method Details

copy

public CumulativeMetersetWeight copy()

Returns a new Cumulative Meterset Weight which wraps a copy of the Attributes wrapped in this Cumulative Meterset Weight. (see Attributes(Attributes)

Returns:

a new Cumulative Meterset Weight which wraps a copy of the Attributes wrapped in this Cumulative Meterset Weight.

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.