Package org.dcm4che.typeddicom.dataelements

Class DepthValueAveragingFlag

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DepthValueAveragingFlag

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DepthValueAveragingFlag
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Depth Value Averaging Flag
Keyword: DepthValueAveragingFlag
Tag: (300A,0093)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Module > Beam Sequence > Referenced Dose Reference Sequence > Depth Value Averaging Flag
  as follows:
  Attribute Name: Depth Value Averaging Flag
  Type: 1C
  Attribute Description:

  Whether or not the depth values have been averaged.

  Enumerated Values:

  YES

  The values represent average values from the current Verification Control Point to the next

  NO

  The values refer to a single location

  Required if the referenced beam describes an angular movement and the depth values change during movement.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
DepthValueAveragingFlag	copy()	Returns a new Depth Value Averaging Flag which wraps a copy of the Attributes wrapped in this Depth Value Averaging Flag.
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

DepthValueAveragingFlag

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

Creates a new Depth Value Averaging Flag object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DepthValueAveragingFlag

public DepthValueAveragingFlag()

Creates a new Depth Value Averaging Flag object which wraps a new and empty Attributes object.

Method Details

copy

public DepthValueAveragingFlag copy()

Returns a new Depth Value Averaging Flag which wraps a copy of the Attributes wrapped in this Depth Value Averaging Flag. (see Attributes(Attributes)

Returns:

a new Depth Value Averaging Flag which wraps a copy of the Attributes wrapped in this Depth Value Averaging Flag.

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.