Package org.dcm4che.typeddicom.dataelements

Class DoseValuePurpose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseValuePurpose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringMultiWrapper, StringDataElementMultiWrapper

public class DoseValuePurpose
extends AbstractDataElementWrapper
implements CodeStringMultiWrapper

Name: Dose Value Purpose
Keyword: DoseValuePurpose
Tag: (300A,061D)
Value Representation: CS
Value Multiplicity: 1-n

• Described in the contexts:
  • RT Dose Contribution Module > Radiation Dose Sequence > Radiation Dose Values Parameters Sequence > Dose Values Sequence > Dose Value Purpose
  as follows:
  Attribute Name: Dose Value Purpose
  Type: 1
  Attribute Description:

  Purpose(s) for which dose values in this Sequence Item are provided.

  Defined Terms:

  TRACKING

  The dose values are used for tracking.

  QA

  The dose values are used for quality assurance.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
DoseValuePurpose()	Creates a new Dose Value Purpose object which wraps a new and empty Attributes object.
DoseValuePurpose(org.dcm4che3.data.Attributes attributes)	Creates a new Dose Value Purpose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DoseValuePurpose	copy()	Returns a new Dose Value Purpose which wraps a copy of the Attributes wrapped in this Dose Value Purpose.
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.CodeStringMultiWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

getString, getString, getStrings, setStrings

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

DoseValuePurpose

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

Creates a new Dose Value Purpose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseValuePurpose

public DoseValuePurpose()

Creates a new Dose Value Purpose object which wraps a new and empty Attributes object.

Method Details

copy

public DoseValuePurpose copy()

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

Returns:

a new Dose Value Purpose which wraps a copy of the Attributes wrapped in this Dose Value Purpose.

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.