BeamSequence (dcm4che-typeddicom-lib-std 0.5.5 API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<T>
  - - org.dcm4che.typeddicom.SequenceWrapper<BeamSequence,BeamSequence.Item>
    - - org.dcm4che.typeddicom.dataelements.BeamSequence

All Implemented Interfaces:

java.lang.Iterable<BeamSequence.Item>, java.util.Collection<BeamSequence.Item>, java.util.List<BeamSequence.Item>
```
public class BeamSequence
extends org.dcm4che.typeddicom.SequenceWrapper<BeamSequence,BeamSequence.Item>
```
Name: Beam Sequence
Keyword: BeamSequence
Tag: (300A,00B0)
Value Representation: Sequence
Value Multiplicity: 1
- Described in the contexts:
  - RT Patient Position Scope With Legacy Support Macro > Referenced RT Plan Sequence > Beam Sequence
  as follows:
  Attribute Name: Beam Sequence
  Type: 1C
  Attribute Description:
  A subset of RT Beams included in the RT Plan SOP Instance for which the parameters apply.
  
  Required if the scope is limited to a subset of RT Beams of the referenced RT Plan and the Number Of Beams (300A,0080) is not zero.
  
  One or more Items shall be included in this Sequence. The maximum number of Items is one less than the number of RT Beams in the referenced RT Plan SOP Instance.
- Described in the contexts:
  - RT Beams Module > Beam Sequence
  as follows:
  Attribute Name: Beam Sequence
  Type: 1
  Attribute Description:
  Sequence of treatment beams for current RT Plan.
  
  One or more Items shall be included in this Sequence.

Nested Class Summary

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

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

Fields inherited from class java.util.AbstractList
modCount

Constructor Summary

Constructors
Constructor Description

BeamSequence(org.dcm4che3.data.Sequence sequence)
Creates a new Beam Sequence object which wraps the provided sequence.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

java.lang.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 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
  - BeamSequence
```
public BeamSequence(org.dcm4che3.data.Sequence sequence)
```
    Creates a new Beam Sequence object which wraps the provided sequence.
    
    Parameters:
    
    sequence - the Sequence object to be linked.
- Method Detail
  - getPrivateCreator
```
public java.lang.String getPrivateCreator()
```
    Specified by:
    
    getPrivateCreator in class org.dcm4che.typeddicom.SequenceWrapper<BeamSequence,BeamSequence.Item>
  - getTag
```
public int getTag()
```
    Specified by:
    
    getTag in class org.dcm4che.typeddicom.SequenceWrapper<BeamSequence,BeamSequence.Item>