Package org.dcm4che.typeddicom.dataelements

Class NominalEnergy

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.NominalEnergy

All Implemented Interfaces:

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

public class NominalEnergy
extends AbstractDataElementWrapper
implements DecimalStringWrapper

Name: Nominal Energy
Keyword: NominalEnergy
Tag: (300A,0680)
Value Representation: DS
Value Multiplicity: 1

• Described in the contexts:
  • Radiation Generation Mode Macro > Radiation Generation Mode Sequence > Nominal Energy
  as follows:
  Attribute Name: Nominal Energy
  Type: 1C
  Attribute Description:

  The nominal beam energy in units as defined in the Energy Unit Code Sequence (300A,0684).

  Required if Minimum Nominal Energy (300A,0681) and Maximum Nominal Energy (300A,0682) are not present.

  See DICOM Standard Part 3 - Section C.36.2.2.7.1.1.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

NominalEnergy

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

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

Parameters:

attributes - The Attributes object to be wrapped.

NominalEnergy

public NominalEnergy()

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

Method Details

copy

public NominalEnergy copy()

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

Returns:

a new Nominal Energy which wraps a copy of the Attributes wrapped in this Nominal 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.