Package org.dcm4che.typeddicom.dataelements

Class CompensatorDescription

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorDescription

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, LongTextWrapper, StringDataElementWrapper

public class CompensatorDescription
extends AbstractDataElementWrapper
implements LongTextWrapper

Name: Compensator Description
Keyword: CompensatorDescription
Tag: (300A,02EB)
Value Representation: LT
Value Multiplicity: 1

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

  User defined description for the compensator.

  
  

Nested Class Summary

Nested Classes

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

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

Method Summary

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

CompensatorDescription

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorDescription

public CompensatorDescription()

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

Method Details

copy

public CompensatorDescription copy()

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

Returns:

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

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.