Package org.dcm4che.typeddicom.dataelements

Class FluenceMode

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FluenceMode

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class FluenceMode
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Fluence Mode
Keyword: FluenceMode
Tag: (3002,0051)
Value Representation: CS
Value Multiplicity: 1

• Described in the contexts:
  • RT Beams Session Record Module > Treatment Session Beam Sequence > Primary Fluence Mode Sequence > Fluence Mode
  • RT Image Module > Exposure Sequence > Primary Fluence Mode Sequence > Fluence Mode
  • RT Beams Module > Beam Sequence > Primary Fluence Mode Sequence > Fluence Mode
  as follows:
  Attribute Name: Fluence Mode
  Type: 1
  Attribute Description:

  Describes whether the fluence shaping is the standard mode for the beam or an alternate.

  Enumerated Values:

  STANDARD

  Uses standard fluence-shaping

  NON_STANDARD

  Uses a non-standard fluence-shaping mode

  
  

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
FluenceMode	copy()	Returns a new Fluence Mode which wraps a copy of the Attributes wrapped in this Fluence Mode.
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, getPrivateCreator, 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

Constructor Details

FluenceMode

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

Creates a new Fluence Mode object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

FluenceMode

public FluenceMode()

Creates a new Fluence Mode object which wraps a new and empty Attributes object.

Method Details

copy

public FluenceMode copy()

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

Returns:

a new Fluence Mode which wraps a copy of the Attributes wrapped in this Fluence Mode.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.