Package org.dcm4che.typeddicom.dataelements

Class CompensatorMountingPosition

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorMountingPosition

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, CodeStringWrapper, StringDataElementWrapper

public class CompensatorMountingPosition
extends AbstractDataElementWrapper
implements CodeStringWrapper

Name: Compensator Mounting Position
Keyword: CompensatorMountingPosition
Tag: (300A,02E1)
Value Representation: CS
Value Multiplicity: 1

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

  Indicates on which side of the Compensator Tray the compensator is mounted.

  Enumerated Values:

  PATIENT_SIDE

  the compensator is mounted on the side of the Compensator Tray that is towards the patient.

  SOURCE_SIDE

  the compensator is mounted on the side of the Compensator Tray that is towards the radiation source.

  DOUBLE_SIDED

  the compensator has a shaped (i.e., non-flat) surface on both sides of the Compensator Tray.

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

  Indicates on which side of the Compensator Tray the compensator is mounted.

  Enumerated Values:

  PATIENT_SIDE

  the Compensator is mounted on the side of the Compensator Tray that is towards the patient.

  SOURCE_SIDE

  the Compensator is mounted on the side of the Compensator Tray that is towards the radiation source.

  DOUBLE_SIDED

  the Compensator has a shaped (i.e., non-flat) surface on both sides of the Compensator Tray.

  
  

Nested Class Summary

Nested Classes

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

Method Summary

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

PRIVATE_CREATOR

public static final 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 Details

CompensatorMountingPosition

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

Creates a new Compensator Mounting Position object which wraps the provided attributes.

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorMountingPosition

public CompensatorMountingPosition()

Creates a new Compensator Mounting Position object which wraps a new and empty Attributes object.

Method Details

copy

public CompensatorMountingPosition copy()

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

Returns:

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

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in interface DataElementWrapper

Returns:

The DICOM Private Creator of the wrapped DICOM attributes. null if not private

getTag

public int getTag()

Specified by:

getTag in interface DataElementWrapper

Returns:

The DICOM Tag of the wrapped DICOM attributes.