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:

org.dcm4che.typeddicom.AttributesWrapper, org.dcm4che.typeddicom.DataElementWrapper, org.dcm4che.typeddicom.valuerepresentations.BytesDataElementWrapper, ShortStringWrapper, org.dcm4che.typeddicom.valuerepresentations.StringDataElementWrapper

public class RangeModulatorID
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements ShortStringWrapper

Name: Range Modulator ID
Keyword: RangeModulatorID
Tag: (300A,0346)
Value Representation: ShortString
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)
static class	RangeModulatorID.SimpleHolder

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PRIVATE_CREATOR	The Private Creator associated with this class.
static 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
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.
java.lang.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 Detail

PRIVATE_CREATOR

public static final java.lang.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 Detail

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 Detail

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.

getPrivateCreator

public java.lang.String getPrivateCreator()

Specified by:

getPrivateCreator in interface org.dcm4che.typeddicom.DataElementWrapper

getTag

public int getTag()

Specified by:

getTag in interface org.dcm4che.typeddicom.DataElementWrapper