Package org.dcm4che.typeddicom.dataelements

Class DoseType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.DoseType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class DoseType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Dose Type
Keyword: DoseType
Tag: (3004,0004)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT DVH Module > DVH Sequence > Dose Type
  • RT Dose Module > Dose Type
  as follows:
  Attribute Name: Dose Type
  Type: 1
  Attribute Description:

  Type of dose.

  Defined Terms:

  PHYSICAL

  physical dose

  EFFECTIVE

  physical dose after correction for biological effect using user-defined modeling technique

  ERROR

  difference between desired and planned dose

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
DoseType	copy()	Returns a new Dose Type which wraps a copy of the Attributes wrapped in this Dose Type.
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, getPrivateCreator, getValue

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

DoseType

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

Creates a new Dose Type object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

DoseType

public DoseType()

Creates a new Dose Type object which wraps a new and empty Attributes object.

Method Details

copy

public DoseType copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.