Package org.dcm4che.typeddicom.dataelements

Class CompensatorType

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorType

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class CompensatorType
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Compensator Type
Keyword: CompensatorType
Tag: (300A,00EE)
Value Representation: CS
Value Multiplicity: 1

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

  Type of compensator (if any).

  Defined Terms:

  STANDARD

  physical (static) compensator

  DYNAMIC

  moving Beam Limiting Device (collimator) simulating compensator

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

  Type of compensator (if any).

  Defined Terms:

  STANDARD

  physical (static) compensator

  DYNAMIC

  moving Beam Limiting Device (collimator) simulating physical compensator

  
  

Nested Class Summary

Nested Classes

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

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

CodeStringWrapper.Setter<B extends Builder<B,? extends AttributesWrapper>,D extends CodeStringWrapper>

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

Constructor	Description
CompensatorType()	Creates a new Compensator Type object which wraps a new and empty Attributes object.
CompensatorType(org.dcm4che3.data.Attributes attributes)	Creates a new Compensator Type object which wraps the provided attributes.

Method Summary

Modifier and Type	Method	Description
CompensatorType	copy()	Returns a new Compensator Type which wraps a copy of the Attributes wrapped in this Compensator Type.
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.valuerepresentations.CodeStringWrapper

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getPrivateCreator, 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

Constructor Details

CompensatorType

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorType

public CompensatorType()

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

Method Details

copy

public CompensatorType copy()

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

Returns:

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

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.