Package org.dcm4che.typeddicom.dataelements

Class RangeShifterID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.RangeShifterID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class RangeShifterID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Range Shifter ID
Keyword: RangeShifterID
Tag: (300A,0318)
Value Representation: SH
Value Multiplicity: 1

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

  User or machine supplied identifier for Range Modulator.

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

  User or machine supplied identifier for Range Modulator.

  
  
• Described in the contexts:
  • RT Ion Beams Module > Ion Beam Sequence > Range Shifter Sequence > Range Shifter ID
  as follows:
  Attribute Name: Range Shifter ID
  Type: 1
  Attribute Description:

  User or machine supplied identifier for Range Shifter.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

RangeShifterID

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

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

Parameters:

attributes - The Attributes object to be wrapped.

RangeShifterID

public RangeShifterID()

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

Method Details

copy

public RangeShifterID copy()

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

Returns:

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