Package org.dcm4che.typeddicom.dataelements

Class RangeModulatorID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangeModulatorID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class RangeModulatorID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Range Modulator ID
Keyword: RangeModulatorID
Tag: (300A,0346)
Value Representation: SH
Value Multiplicity: 1

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

  User or machine supplied identifier for Range Modulator.

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

  User or machine supplied identifier for Range Modulator.

  
  

Nested Class Summary

Nested Classes

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

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 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
RangeModulatorID()	Creates a new Range Modulator ID object which wraps a new and empty Attributes object.
RangeModulatorID(org.dcm4che3.data.Attributes attributes)	Creates a new Range Modulator ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
RangeModulatorID	copy()	Returns a new Range Modulator ID which wraps a copy of the Attributes wrapped in this Range Modulator 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

RangeModulatorID

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

Creates a new Range Modulator ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

RangeModulatorID

public RangeModulatorID()

Creates a new Range Modulator ID object which wraps a new and empty Attributes object.

Method Details

copy

public RangeModulatorID copy()

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

Returns:

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