Package org.dcm4che.typeddicom.dataelements

Class ReferenceDoseDefinition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.ReferenceDoseDefinition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class ReferenceDoseDefinition
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Reference Dose Definition
Keyword: ReferenceDoseDefinition
Tag: (300A,0512)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Depth Dose Parameters Sequence > Reference Dose Definition
  as follows:
  Attribute Name: Reference Dose Definition
  Type: 1
  Attribute Description:

  Definition of the 100% reference dose level.

  Defined Terms:

  HIGHEST

  MAXIMUM

  CENTER

  See DICOM Standard Part 3 - Section C.8.8.25.9.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferenceDoseDefinition.Builder<SELF extends ReferenceDoseDefinition.Builder<SELF,T>,T extends ReferenceDoseDefinition.Holder>
static interface	ReferenceDoseDefinition.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Reference Dose Definition" (see ReferenceDoseDefinition)
static class	ReferenceDoseDefinition.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 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.CodeStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
ReferenceDoseDefinition()	Creates a new Reference Dose Definition object which wraps a new and empty Attributes object.
ReferenceDoseDefinition(org.dcm4che3.data.Attributes attributes)	Creates a new Reference Dose Definition object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
ReferenceDoseDefinition	copy()	Returns a new Reference Dose Definition which wraps a copy of the Attributes wrapped in this Reference Dose Definition.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

ReferenceDoseDefinition

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

Creates a new Reference Dose Definition object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

ReferenceDoseDefinition

public ReferenceDoseDefinition()

Creates a new Reference Dose Definition object which wraps a new and empty Attributes object.

Method Details

copy

public ReferenceDoseDefinition copy()

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

Returns:

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

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.