Package org.dcm4che.typeddicom.dataelements

Class CompensatorDivergence

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorDivergence

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class CompensatorDivergence
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Compensator Divergence
Keyword: CompensatorDivergence
Tag: (300A,02E0)
Value Representation: CS
Value Multiplicity: 1

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

  Indicates presence or absence of geometrical divergence of the range compensator.

  Enumerated Values:

  PRESENT

  the range compensator is shaped according to the beam geometrical divergence.

  ABSENT

  the range compensator is not shaped according to the beam geometrical divergence.

  
  
• Described in the contexts:
  • Compensators Definition Macro > Compensator Definition Sequence > Compensator Shape Sequence > Compensator Divergence
  as follows:
  Attribute Name: Compensator Divergence
  Type: 1
  Attribute Description:

  Whether or not the compensator is shaped according to the beam geometrical divergence.

  Enumerated Values:

  PRESENT

  The compensator is shaped according to the beam geometrical divergence.

  ABSENT

  The compensator is not shaped according to the beam geometrical divergence.

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

  Indicates presence or absence of geometrical divergence of the compensator.

  Enumerated Values:

  PRESENT

  the compensator is shaped according to the beam geometrical divergence.

  ABSENT

  the compensator is not shaped according to the beam geometrical divergence.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CompensatorDivergence.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Compensator Divergence" (see CompensatorDivergence)

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
CompensatorDivergence()	Creates a new Compensator Divergence object which wraps a new and empty Attributes object.
CompensatorDivergence(org.dcm4che3.data.Attributes attributes)	Creates a new Compensator Divergence object which wraps the provided attributes.

Method Summary

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

CompensatorDivergence

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorDivergence

public CompensatorDivergence()

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

Method Details

copy

public CompensatorDivergence copy()

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

Returns:

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

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.