Package org.dcm4che.typeddicom.dataelements

Class DeliveryWarningDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DeliveryWarningDose

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, DecimalStringWrapper, DoubleDataElementWrapper, FloatDataElementWrapper, StringDataElementWrapper

public class DeliveryWarningDose
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Delivery Warning Dose
Keyword: DeliveryWarningDose
Tag: (300A,0022)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Prescription Module > Dose Reference Sequence > Delivery Warning Dose
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Dose Reference Sequence > Delivery Warning Dose
  as follows:
  Attribute Name: Delivery Warning Dose
  Type: 3
  Attribute Description:

  The dose (in Gy) that when reached or exceeded should cause some action to be taken.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeliveryWarningDose.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Delivery Warning Dose" (see DeliveryWarningDose)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
DeliveryWarningDose()	Creates a new Delivery Warning Dose object which wraps a new and empty Attributes object.
DeliveryWarningDose(org.dcm4che3.data.Attributes attributes)	Creates a new Delivery Warning Dose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
DeliveryWarningDose	copy()	Returns a new Delivery Warning Dose which wraps a copy of the Attributes wrapped in this Delivery Warning Dose.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

exists, getValue

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

getDouble, setDouble

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

getFloat, setFloat

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

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

DeliveryWarningDose

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

Creates a new Delivery Warning Dose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DeliveryWarningDose

public DeliveryWarningDose()

Creates a new Delivery Warning Dose object which wraps a new and empty Attributes object.

Method Details

copy

public DeliveryWarningDose copy()

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

Returns:

a new Delivery Warning Dose which wraps a copy of the Attributes wrapped in this Delivery Warning Dose.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.