Package org.dcm4che.typeddicom.dataelements

Class DosimetricObjectiveWeight

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DosimetricObjectiveWeight

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, FloatingPointDoubleWrapper

public class DosimetricObjectiveWeight
extends AbstractDataElementWrapper
implements FloatingPointDoubleWrapper

Name: Dosimetric Objective Weight
Keyword: DosimetricObjectiveWeight
Tag: (3010,0074)
Value Representation: FD
Value Multiplicity: 1

• Described in the contexts:
  • RT Enhanced Prescription Module > RT Prescription Sequence > Referenced Dosimetric Objectives Sequence > Dosimetric Objective Weight
  as follows:
  Attribute Name: Dosimetric Objective Weight
  Type: 1C
  Attribute Description:

  Weight of importance to be applied to the Dosimetric Objective. A higher value means that this objective is more important. Values are only meaningful within the Items in this Sequence. The use of weight value in the process of optimization and treatment parameter definition is implementation-dependent.

  Required if Absolute Dosimetric Objective Flag (3010,0073) is NO.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DosimetricObjectiveWeight()	Creates a new Dosimetric Objective Weight object which wraps a new and empty Attributes object.
DosimetricObjectiveWeight(org.dcm4che3.data.Attributes attributes)	Creates a new Dosimetric Objective Weight object which wraps the provided attributes.

Method Summary

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

getDouble, setDouble

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatDataElementWrapper

getFloat, setFloat

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.FloatingPointDoubleWrapper

getValueRepresentation

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

DosimetricObjectiveWeight

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

Creates a new Dosimetric Objective Weight object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DosimetricObjectiveWeight

public DosimetricObjectiveWeight()

Creates a new Dosimetric Objective Weight object which wraps a new and empty Attributes object.

Method Details

copy

public DosimetricObjectiveWeight copy()

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

Returns:

a new Dosimetric Objective Weight which wraps a copy of the Attributes wrapped in this Dosimetric Objective 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.