Package org.dcm4che.typeddicom.dataelements

Class TargetUnderdoseVolumeFraction

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.TargetUnderdoseVolumeFraction

All Implemented Interfaces:

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

public class TargetUnderdoseVolumeFraction
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Target Underdose Volume Fraction
Keyword: TargetUnderdoseVolumeFraction
Tag: (300A,0028)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Prescription Module > Dose Reference Sequence > Target Underdose Volume Fraction
  as follows:
  Attribute Name: Target Underdose Volume Fraction
  Type: 3
  Attribute Description:

  Maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose if Dose Reference Type (300A,0020) is TARGET and Dose Reference Structure Type (300A,0014) is VOLUME. See DICOM Standard Part 3 - Section C.8.8.10.1.

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

  Maximum permitted fraction (in percent) of Target to receive less than the Target Prescription Dose (300A,0027) if Dose Reference Type (300A,0020) of referenced Dose Reference is TARGET and Dose Reference Structure Type (300A,0014) of referenced Dose Reference is VOLUME.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
TargetUnderdoseVolumeFraction	copy()	Returns a new Target Underdose Volume Fraction which wraps a copy of the Attributes wrapped in this Target Underdose Volume Fraction.
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, getPrivateCreator, 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

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

Constructor Details

TargetUnderdoseVolumeFraction

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

Creates a new Target Underdose Volume Fraction object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

TargetUnderdoseVolumeFraction

public TargetUnderdoseVolumeFraction()

Creates a new Target Underdose Volume Fraction object which wraps a new and empty Attributes object.

Method Details

copy

public TargetUnderdoseVolumeFraction copy()

Returns a new Target Underdose Volume Fraction which wraps a copy of the Attributes wrapped in this Target Underdose Volume Fraction. (see Attributes(Attributes)

Returns:

a new Target Underdose Volume Fraction which wraps a copy of the Attributes wrapped in this Target Underdose Volume Fraction.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.