Package org.dcm4che.typeddicom.dataelements

Class BeamCurrentModulationID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.BeamCurrentModulationID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class BeamCurrentModulationID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Beam Current Modulation ID
Keyword: BeamCurrentModulationID
Tag: (300A,034C)
Value Representation: SH
Value Multiplicity: 1

• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Range Modulator Sequence > Beam Current Modulation ID
  • RT Ion Beams Session Record Module > Treatment Session Ion Beam Sequence > Recorded Range Modulator Sequence > Beam Current Modulation ID
  as follows:
  Attribute Name: Beam Current Modulation ID
  Type: 1C
  Attribute Description:

  User-supplied identifier for the beam current modulation pattern. Required if Range Modulator Type (300A,0348) is WHL_MODWEIGHTS

  
  
• Described in the contexts:
  • RT Ion Machine Verification Module > Ion Machine Verification Sequence > Recorded Range Modulator Sequence > Beam Current Modulation ID
  as follows:
  Attribute Name: Beam Current Modulation ID
  Type:
  Attribute Description:

  User-supplied identifier for the beam current modulation pattern.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BeamCurrentModulationID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Beam Current Modulation ID" (see BeamCurrentModulationID)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TAG	The DICOM Tag associated with this class.
static final org.dcm4che3.data.VR	VALUE_REPRESENTATION	The DICOM Value Representation (VR) associated with this class.

Constructor Summary

Constructors

Constructor	Description
BeamCurrentModulationID()	Creates a new Beam Current Modulation ID object which wraps a new and empty Attributes object.
BeamCurrentModulationID(org.dcm4che3.data.Attributes attributes)	Creates a new Beam Current Modulation ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
BeamCurrentModulationID	copy()	Returns a new Beam Current Modulation ID which wraps a copy of the Attributes wrapped in this Beam Current Modulation ID.
int	getTag()
org.dcm4che3.data.VR	getValueRepresentation()

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

getString, setString

Field Details

TAG

public static final int TAG

The DICOM Tag associated with this class.

See Also:

• Constant Field Values

VALUE_REPRESENTATION

public static final org.dcm4che3.data.VR VALUE_REPRESENTATION

The DICOM Value Representation (VR) associated with this class.

Constructor Details

BeamCurrentModulationID

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

Creates a new Beam Current Modulation ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

BeamCurrentModulationID

public BeamCurrentModulationID()

Creates a new Beam Current Modulation ID object which wraps a new and empty Attributes object.

Method Details

copy

public BeamCurrentModulationID copy()

Returns a new Beam Current Modulation ID which wraps a copy of the Attributes wrapped in this Beam Current Modulation ID. (see Attributes(Attributes)

Returns:

a new Beam Current Modulation ID which wraps a copy of the Attributes wrapped in this Beam Current Modulation ID.

getValueRepresentation

public org.dcm4che3.data.VR getValueRepresentation()

Specified by:

getValueRepresentation in interface DataElementWrapper

Returns:

The DICOM Value Representation (VR) of the wrapped DICOM sequence.

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM sequence.