Package org.dcm4che.typeddicom.dataelements

Class OrganAtRiskFullVolumeDose

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OrganAtRiskFullVolumeDose

All Implemented Interfaces:

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

public class OrganAtRiskFullVolumeDose
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Organ at Risk Full-volume Dose
Keyword: OrganAtRiskFullVolumeDose
Tag: (300A,002A)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Dose Reference Sequence > Organ at Risk Full-volume Dose
  as follows:
  Attribute Name: Organ at Risk Full-volume Dose
  Type: 3
  Attribute Description:

  Maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) of referenced Dose Reference is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

  
  
• Described in the contexts:
  • RT Prescription Module > Dose Reference Sequence > Organ at Risk Full-volume Dose
  as follows:
  Attribute Name: Organ at Risk Full-volume Dose
  Type: 3
  Attribute Description:

  Maximum dose (in Gy) to entire Dose Reference if Dose Reference Type (300A,0020) is ORGAN_AT_RISK and Dose Reference Structure Type (300A,0014) is VOLUME.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	OrganAtRiskFullVolumeDose.Builder<SELF extends OrganAtRiskFullVolumeDose.Builder<SELF,T>,T extends OrganAtRiskFullVolumeDose.Holder>
static interface	OrganAtRiskFullVolumeDose.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Organ at Risk Full-volume Dose" (see OrganAtRiskFullVolumeDose)
static class	OrganAtRiskFullVolumeDose.SimpleHolder

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
OrganAtRiskFullVolumeDose()	Creates a new Organ at Risk Full-volume Dose object which wraps a new and empty Attributes object.
OrganAtRiskFullVolumeDose(org.dcm4che3.data.Attributes attributes)	Creates a new Organ at Risk Full-volume Dose object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OrganAtRiskFullVolumeDose	copy()	Returns a new Organ at Risk Full-volume Dose which wraps a copy of the Attributes wrapped in this Organ at Risk Full-volume Dose.
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.DataElementWrapper

exists, getValue

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

getValueRepresentation

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

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

OrganAtRiskFullVolumeDose

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

Creates a new Organ at Risk Full-volume Dose object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OrganAtRiskFullVolumeDose

public OrganAtRiskFullVolumeDose()

Creates a new Organ at Risk Full-volume Dose object which wraps a new and empty Attributes object.

Method Details

copy

public OrganAtRiskFullVolumeDose copy()

Returns a new Organ at Risk Full-volume Dose which wraps a copy of the Attributes wrapped in this Organ at Risk Full-volume Dose. (see Attributes(Attributes)

Returns:

a new Organ at Risk Full-volume Dose which wraps a copy of the Attributes wrapped in this Organ at Risk Full-volume Dose.

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.