Package org.dcm4che.typeddicom.dataelements

Class BeamDoseMeaning

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamDoseMeaning

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class BeamDoseMeaning
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Beam Dose Meaning
Keyword: BeamDoseMeaning
Tag: (300A,008B)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Beam Dose Meaning
  as follows:
  Attribute Name: Beam Dose Meaning
  Type: 3
  Attribute Description:

  Indicates the meaning of Beam Dose (300A,0084).

  Enumerated Values:

  BEAM_LEVEL

  Beam Dose value is individually calculated for this Beam

  FRACTION_LEVEL

  Dose is calculated on the Fraction level, and the value of Beam Dose (300A,0084) is assigned to the Beam to carry a nominally distributed dose only.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BeamDoseMeaning.Builder<SELF extends BeamDoseMeaning.Builder<SELF,T>,T extends BeamDoseMeaning.Holder>
static interface	BeamDoseMeaning.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Beam Dose Meaning" (see BeamDoseMeaning)

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.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BeamDoseMeaning()	Creates a new Beam Dose Meaning object which wraps a new and empty Attributes object.
BeamDoseMeaning(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Dose Meaning object which wraps the provided attributes.

Method Summary

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

BeamDoseMeaning

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

Creates a new Beam Dose Meaning object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamDoseMeaning

public BeamDoseMeaning()

Creates a new Beam Dose Meaning object which wraps a new and empty Attributes object.

Method Details

copy

public BeamDoseMeaning copy()

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

Returns:

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

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.