Package org.dcm4che.typeddicom.dataelements

Class PrimaryDoseValueIndicator

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.PrimaryDoseValueIndicator

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class PrimaryDoseValueIndicator
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Primary Dose Value Indicator
Keyword: PrimaryDoseValueIndicator
Tag: (300A,061B)
Value Representation: CS
Value Multiplicity: 1

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

  Whether the dose value serves as the primary dose indicator for the RT Radiation SOP Instance.

  Enumerated Values:

  YES

  NO

  Exactly one item in the Radiation Dose Values Parameters Sequence (300A,061F) shall have the value YES.

  See DICOM Standard Part 3 - Section C.36.11.1.3.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

PrimaryDoseValueIndicator

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

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

Parameters:

attributes - The Attributes object to be wrapped.

PrimaryDoseValueIndicator

public PrimaryDoseValueIndicator()

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

Method Details

copy

public PrimaryDoseValueIndicator copy()

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

Returns:

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

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.