Package org.dcm4che.typeddicom.dataelements

Class DosimetricObjectivePurpose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DosimetricObjectivePurpose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DosimetricObjectivePurpose
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dosimetric Objective Purpose
Keyword: DosimetricObjectivePurpose
Tag: (3010,0075)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Dosimetric Objective Macro > Dosimetric Objective Purpose
  as follows:
  Attribute Name: Dosimetric Objective Purpose
  Type: 2
  Attribute Description:

  The purpose for which the objective is to be used.

  Enumerated Values:

  OPTIMIZATION

  Used as an input to the optimization process.

  EVALUATION

  Used as a tool for evaluation.

  BOTH

  Used as both an input to the optimization process and for evaluation.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

Constructor Details

DosimetricObjectivePurpose

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

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

Parameters:

attributes - The Attributes object to be wrapped.

DosimetricObjectivePurpose

public DosimetricObjectivePurpose()

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

Method Details

copy

public DosimetricObjectivePurpose copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.