Package org.dcm4che.typeddicom.dataelements

Class NominalBeamEnergy

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalBeamEnergy

All Implemented Interfaces:

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

public class NominalBeamEnergy
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Nominal Beam Energy
Keyword: NominalBeamEnergy
Tag: (300A,0114)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Ion Control Point Delivery Sequence > Nominal Beam Energy
  as follows:
  Attribute Name: Nominal Beam Energy
  Type: 1C
  Attribute Description:

  Nominal Beam Energy at control point in MeV per nucleon. Defined at nozzle entrance before all Beam Modifiers. Required for Control Point 0 of Ion Control Point Delivery Sequence (3008,0041) or if Nominal Beam Energy (300A,0114) changes during beam administration, and KVP (0018,0060) is not present.

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Ion Control Point Verification Sequence > Nominal Beam Energy
  • RT Conventional Machine Verification Module > Conventional Machine Verification Sequence > Conventional Control Point Verification Sequence > Nominal Beam Energy
  as follows:
  Attribute Name: Nominal Beam Energy
  Type:
  Attribute Description:

  Nominal Beam Energy at control point.

  
  
• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Control Point Delivery Sequence > Nominal Beam Energy
  as follows:
  Attribute Name: Nominal Beam Energy
  Type: 3
  Attribute Description:

  Nominal Beam Energy at control point.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Ion Control Point Sequence > Nominal Beam Energy
  as follows:
  Attribute Name: Nominal Beam Energy
  Type: 1C
  Attribute Description:

  Nominal Beam Energy at control point in MeV per nucleon. Defined at nozzle entrance before all Beam Modifiers. Required for first Item of Control Point Sequence, or if Nominal Beam Energy changes during Beam, and KVP (0018,0060) is not present.

  
  
• Described in the contexts:
  • RT Beams Module > Beam Sequence > Control Point Sequence > Nominal Beam Energy
  as follows:
  Attribute Name: Nominal Beam Energy
  Type: 3
  Attribute Description:

  Nominal Beam Energy at control point (MV/MeV).

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NominalBeamEnergy.Builder<SELF extends NominalBeamEnergy.Builder<SELF,T>,T extends NominalBeamEnergy.Holder>
static interface	NominalBeamEnergy.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Nominal Beam Energy" (see NominalBeamEnergy)
static class	NominalBeamEnergy.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 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.DecimalStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
NominalBeamEnergy()	Creates a new Nominal Beam Energy object which wraps a new and empty Attributes object.
NominalBeamEnergy(org.dcm4che3.data.Attributes attributes)	Creates a new Nominal Beam Energy object which wraps the provided attributes.

Method Summary

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

exists, 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

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

NominalBeamEnergy

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

Creates a new Nominal Beam Energy object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

NominalBeamEnergy

public NominalBeamEnergy()

Creates a new Nominal Beam Energy object which wraps a new and empty Attributes object.

Method Details

copy

public NominalBeamEnergy copy()

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

Returns:

a new Nominal Beam Energy which wraps a copy of the Attributes wrapped in this Nominal Beam Energy.

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.