Package org.dcm4che.typeddicom.dataelements

Class CompensatorID

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorID

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, ShortStringWrapper, StringDataElementWrapper

public class CompensatorID
extends AbstractDataElementWrapper
implements ShortStringWrapper

Name: Compensator ID
Keyword: CompensatorID
Tag: (300A,00E5)
Value Representation: SH
Value Multiplicity: 1

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

  User-supplied identifier for compensator.

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

  User-supplied identifier for compensator.

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

  User-supplied identifier for the compensator.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompensatorID.Builder<SELF extends CompensatorID.Builder<SELF,T>,T extends CompensatorID.Holder>
static interface	CompensatorID.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Compensator ID" (see CompensatorID)
static class	CompensatorID.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 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
CompensatorID()	Creates a new Compensator ID object which wraps a new and empty Attributes object.
CompensatorID(org.dcm4che3.data.Attributes attributes)	Creates a new Compensator ID object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CompensatorID	copy()	Returns a new Compensator ID which wraps a copy of the Attributes wrapped in this Compensator ID.
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, getPrivateCreator, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.ShortStringWrapper

getValueRepresentation

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

Constructor Details

CompensatorID

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

Creates a new Compensator ID object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorID

public CompensatorID()

Creates a new Compensator ID object which wraps a new and empty Attributes object.

Method Details

copy

public CompensatorID copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.