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:

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

public class CompensatorDivergence
extends org.dcm4che.typeddicom.AbstractDataElementWrapper
implements CodeStringWrapper

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

• 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

  ABSENT

  
  
• 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

  ABSENT

  
  
• 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

  ABSENT

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

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

getValueRepresentation

Methods inherited from interface org.dcm4che.typeddicom.DataElementWrapper

exists, getValue

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

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 Detail

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.

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