Package org.dcm4che.typeddicom.dataelements

Class AbsoluteDosimetricObjectiveFlag

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.AbsoluteDosimetricObjectiveFlag

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class AbsoluteDosimetricObjectiveFlag
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Absolute Dosimetric Objective Flag
Keyword: AbsoluteDosimetricObjectiveFlag
Tag: (3010,0073)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Dosimetric Objective Macro > Absolute Dosimetric Objective Flag
  as follows:
  Attribute Name: Absolute Dosimetric Objective Flag
  Type: 1
  Attribute Description:

  Whether the objective must be met by the resulting Radiotherapy treatment plan.

  Enumerated Values:

  YES

  Objective must be met.

  NO

  Objective should be met but may be compromised.

  Detecting whether or not a Radiotherapy treatment plan has met this Dosimetric Objective and how this situation is handled is out of scope of the Standard.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AbsoluteDosimetricObjectiveFlag.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Absolute Dosimetric Objective Flag" (see AbsoluteDosimetricObjectiveFlag)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AbsoluteDosimetricObjectiveFlag	copy()	Returns a new Absolute Dosimetric Objective Flag which wraps a copy of the Attributes wrapped in this Absolute Dosimetric Objective Flag.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

AbsoluteDosimetricObjectiveFlag

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

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

Parameters:

attributes - The Attributes object to be wrapped.

AbsoluteDosimetricObjectiveFlag

public AbsoluteDosimetricObjectiveFlag()

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

Method Details

copy

public AbsoluteDosimetricObjectiveFlag copy()

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

Returns:

a new Absolute Dosimetric Objective Flag which wraps a copy of the Attributes wrapped in this Absolute Dosimetric Objective Flag.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.