Package org.dcm4che.typeddicom.dataelements

Class CompensatorNumber

java.lang.Object

org.dcm4che.typeddicom.AbstractAttributesWrapper

org.dcm4che.typeddicom.AbstractDataElementWrapper

org.dcm4che.typeddicom.dataelements.CompensatorNumber

All Implemented Interfaces:

AttributesWrapper, DataElementWrapper, BytesDataElementWrapper, IntDataElementWrapper, IntegerStringWrapper, StringDataElementWrapper

public class CompensatorNumber
extends AbstractDataElementWrapper
implements IntegerStringWrapper

Name: Compensator Number
Keyword: CompensatorNumber
Tag: (300A,00E4)
Value Representation: IS
Value Multiplicity: 1

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

  Identification number of the Compensator. The value of Compensator Number (300A,00E4) shall be unique within the Beam in which it is created.

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

  Identification number of the Compensator. The value of Compensator Number (300A,00E4) shall be unique within the Beam in which it is created. Required if Number of Compensators (300A,00E0) is non-zero.

  
  

Nested Class Summary

Nested Classes

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

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

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

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

VALUE_REPRESENTATION

Constructor Summary

Constructors

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

Method Summary

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

exists, getValue

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntDataElementWrapper

getInt, setInt

Methods inherited from interface org.dcm4che.typeddicom.valuerepresentations.IntegerStringWrapper

getValueRepresentation

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

CompensatorNumber

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

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

Parameters:

attributes - The Attributes object to be wrapped.

CompensatorNumber

public CompensatorNumber()

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

Method Details

copy

public CompensatorNumber copy()

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

Returns:

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

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.