Package org.dcm4che.typeddicom.dataelements

Class CompensatorSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.dcm4che.typeddicom.SequenceWrapper<CompensatorSequence,CompensatorSequence.Item>

org.dcm4che.typeddicom.dataelements.CompensatorSequence

All Implemented Interfaces:

Iterable<CompensatorSequence.Item>, Collection<CompensatorSequence.Item>, List<CompensatorSequence.Item>

public class CompensatorSequence
extends SequenceWrapper<CompensatorSequence,CompensatorSequence.Item>

Name: Compensator Sequence
Keyword: CompensatorSequence
Tag: (300A,00E3)
Value Representation: SQ
Value Multiplicity: 1

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

  Sequence of treatment compensators.

  One or more Items shall be included in this Sequence.

  Required if Number of Compensators (300A,00E0) is non-zero.

  
  

Nested Class Summary

Nested Classes

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

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 class org.dcm4che.typeddicom.SequenceWrapper

VALUE_REPRESENTATION

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
CompensatorSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Compensator Sequence object which wraps the provided sequence.

Method Summary

Modifier and Type	Method	Description
String	getPrivateCreator()
int	getTag()

Methods inherited from class org.dcm4che.typeddicom.SequenceWrapper

add, equals, get, getSequence, getValueRepresentation, hashCode, remove, set, size, toString

Methods inherited from class java.util.AbstractList

add, addAll, clear, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

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

CompensatorSequence

public CompensatorSequence(org.dcm4che3.data.Sequence sequence)

Creates a new Compensator Sequence object which wraps the provided sequence.

Parameters:

sequence - The Sequence object to be linked.

Method Details

getPrivateCreator

public String getPrivateCreator()

Specified by:

getPrivateCreator in class SequenceWrapper<CompensatorSequence,CompensatorSequence.Item>

Returns:

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

getTag

public int getTag()

Specified by:

getTag in class SequenceWrapper<CompensatorSequence,CompensatorSequence.Item>

Returns:

The DICOM Tag of the wrapped DICOM sequence.