Package org.dcm4che.typeddicom.dataelements

Class RadiobiologicalDoseEffectFlag

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RadiobiologicalDoseEffectFlag

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class RadiobiologicalDoseEffectFlag
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Radiobiological Dose Effect Flag
Keyword: RadiobiologicalDoseEffectFlag
Tag: (3010,0002)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • Radiobiological Dose Effect Description Macro > Radiobiological Dose Effect Flag
  as follows:
  Attribute Name: Radiobiological Dose Effect Flag
  Type: 1
  Attribute Description:

  Whether radiobiological effects are taken into account for a given dose value.

  Enumerated Values:

  YES

  Effective dose after correction for biological effect.

  NO

  Physical dose.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
RadiobiologicalDoseEffectFlag	copy()	Returns a new Radiobiological Dose Effect Flag which wraps a copy of the Attributes wrapped in this Radiobiological Dose Effect 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

RadiobiologicalDoseEffectFlag

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

Creates a new Radiobiological Dose Effect Flag object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RadiobiologicalDoseEffectFlag

public RadiobiologicalDoseEffectFlag()

Creates a new Radiobiological Dose Effect Flag object which wraps a new and empty Attributes object.

Method Details

copy

public RadiobiologicalDoseEffectFlag copy()

Returns a new Radiobiological Dose Effect Flag which wraps a copy of the Attributes wrapped in this Radiobiological Dose Effect Flag. (see Attributes(Attributes)

Returns:

a new Radiobiological Dose Effect Flag which wraps a copy of the Attributes wrapped in this Radiobiological Dose Effect 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.