Package org.dcm4che.typeddicom.dataelements

Class FluenceModeID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.FluenceModeID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class FluenceModeID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Fluence Mode ID
Keyword: FluenceModeID
Tag: (3002,0052)
Value Representation: SH
Value Multiplicity: 1

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

  Identifier for the specific fluence-shaping mode.

  Required if Fluence Mode (3002,0051) has value NON_STANDARD.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FluenceModeID.Builder<SELF extends FluenceModeID.Builder<SELF,T>,T extends FluenceModeID.Holder>
static interface	FluenceModeID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Fluence Mode ID" (see FluenceModeID)
static class	FluenceModeID.SimpleHolder

Nested classes/interfaces inherited from interface org.dcm4che.typeddicom.valuerepresentations.ShortStringWrapper

ShortStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends ShortStringWrapper>

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.ShortStringWrapper

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
FluenceModeID()	Creates a new Fluence Mode ID object which wraps a new and empty Attributes object.
FluenceModeID(org.dcm4che3.data.Attributes attributes)	Creates a new Fluence Mode ID object which wraps the provided attributes.

Method Summary

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

getValueRepresentation

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

FluenceModeID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

FluenceModeID

public FluenceModeID()

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

Method Details

copy

public FluenceModeID copy()

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

Returns:

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

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.