Package org.dcm4che.typeddicom.dataelements

Class NominalBeamEnergyUnit

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalBeamEnergyUnit

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class NominalBeamEnergyUnit
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Nominal Beam Energy Unit
Keyword: NominalBeamEnergyUnit
Tag: (300A,0015)
Value Representation: CS
Value Multiplicity: 1

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

  Units used for Nominal Beam Energy (300A,0114). Required if Nominal Beam Energy (300A,0114) is present.

  Defined Terms:

  MV

  Megavolt

  MEV

  Mega electron-Volt

  If Radiation Type (300A,00C6) is PHOTON, Nominal Beam Energy Unit (300A,0015) shall be MV. If Radiation Type (300A,00C6) is ELECTRON, Nominal Beam Energy Unit (300A,0015) shall be MEV.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

NominalBeamEnergyUnit

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

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

Parameters:

attributes - The Attributes object to be wrapped.

NominalBeamEnergyUnit

public NominalBeamEnergyUnit()

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

Method Details

copy

public NominalBeamEnergyUnit copy()

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

Returns:

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

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.