Package org.dcm4che.typeddicom.dataelements

Class OrganAtRiskOverdoseVolumeFraction

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.OrganAtRiskOverdoseVolumeFraction

All Implemented Interfaces:

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

public class OrganAtRiskOverdoseVolumeFraction
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Organ at Risk Overdose Volume Fraction
Keyword: OrganAtRiskOverdoseVolumeFraction
Tag: (300A,002D)
Value Representation: DS
Value Multiplicity: 1

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

  Maximum permitted fraction (in percent) of Organ at Risk to receive more than the Organ at Risk Maximum Dose 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 Overdose Volume Fraction
  as follows:
  Attribute Name: Organ at Risk Overdose Volume Fraction
  Type: 3
  Attribute Description:

  Maximum permitted fraction (in percent) of the Organ at Risk to receive more than the Organ at Risk Maximum Dose 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	OrganAtRiskOverdoseVolumeFraction.Builder<SELF extends OrganAtRiskOverdoseVolumeFraction.Builder<SELF,T>,T extends OrganAtRiskOverdoseVolumeFraction.Holder>
static interface	OrganAtRiskOverdoseVolumeFraction.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Organ at Risk Overdose Volume Fraction" (see OrganAtRiskOverdoseVolumeFraction)

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 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
OrganAtRiskOverdoseVolumeFraction()	Creates a new Organ at Risk Overdose Volume Fraction object which wraps a new and empty Attributes object.
OrganAtRiskOverdoseVolumeFraction(org.dcm4che3.data.Attributes attributes)	Creates a new Organ at Risk Overdose Volume Fraction object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
OrganAtRiskOverdoseVolumeFraction	copy()	Returns a new Organ at Risk Overdose Volume Fraction which wraps a copy of the Attributes wrapped in this Organ at Risk Overdose Volume Fraction.
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

OrganAtRiskOverdoseVolumeFraction

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

Creates a new Organ at Risk Overdose Volume Fraction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

OrganAtRiskOverdoseVolumeFraction

public OrganAtRiskOverdoseVolumeFraction()

Creates a new Organ at Risk Overdose Volume Fraction object which wraps a new and empty Attributes object.

Method Details

copy

public OrganAtRiskOverdoseVolumeFraction copy()

Returns a new Organ at Risk Overdose Volume Fraction which wraps a copy of the Attributes wrapped in this Organ at Risk Overdose Volume Fraction. (see Attributes(Attributes)

Returns:

a new Organ at Risk Overdose Volume Fraction which wraps a copy of the Attributes wrapped in this Organ at Risk Overdose Volume Fraction.

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.