Package org.dcm4che.typeddicom.dataelements

Class DosimetricObjectiveEvaluationScope

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DosimetricObjectiveEvaluationScope

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DosimetricObjectiveEvaluationScope
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dosimetric Objective Evaluation Scope
Keyword: DosimetricObjectiveEvaluationScope
Tag: (3010,0063)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Enhanced Prescription Module > Dosimetric Objective Sequence > Dosimetric Objective Evaluation Scope
  as follows:
  Attribute Name: Dosimetric Objective Evaluation Scope
  Type: 1
  Attribute Description:

  Whether the Dosimetric Objective is intended to be evaluated over a lifetime scope or only in respect to the current prescriptions.

  Enumerated Values:

  CURRENT

  The Dosimetric Objective applies to the referencing prescriptions.

  LIFETIME

  The Dosimetric Objective applies to the referencing prescriptions and accumulated lifetime dose.

  See DICOM Standard Part 3 - Section C.36.6.1.7.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

DosimetricObjectiveEvaluationScope

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DosimetricObjectiveEvaluationScope

public DosimetricObjectiveEvaluationScope()

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

Method Details

copy

public DosimetricObjectiveEvaluationScope copy()

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

Returns:

a new Dosimetric Objective Evaluation Scope which wraps a copy of the Attributes wrapped in this Dosimetric Objective Evaluation Scope.

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.