Package org.dcm4che.typeddicom.dataelements

Class ReferencedBeamSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

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

org.dcm4che.typeddicom.dataelements.ReferencedBeamSequence

All Implemented Interfaces:

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

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

Name: Referenced Beam Sequence
Keyword: ReferencedBeamSequence
Tag: (300C,0004)
Value Representation: SQ
Value Multiplicity: 1

• Described in the contexts:
  • RT Dose Module > Referenced Treatment Record Sequence > Referenced Beam Sequence
  as follows:
  Attribute Name: Referenced Beam Sequence
  Type: 1C
  Attribute Description:

  Sequence of Beams contributing to dose.

  One or more Items shall be included in this Sequence.

  Required, if the dose does not apply to the complete RT Beams Treatment Record referenced in the Referenced Treatment Record Sequence (3008,0030).

  
  
• Described in the contexts:
  • RT Dose Module > Referenced RT Plan Sequence > Referenced Fraction Group Sequence > Referenced Beam Sequence
  as follows:
  Attribute Name: Referenced Beam Sequence
  Type: 1C
  Attribute Description:

  Sequence of Beams in current Fraction Group contributing to dose. Required if Dose Summation Type (3004,000A) is BEAM, BEAM_SESSION or CONTROL_POINT.

  One or more Items shall be included in this Sequence.

  
  
• Described in the contexts:
  • RT Fraction Scheme Module > Fraction Group Sequence > Referenced Beam Sequence
  as follows:
  Attribute Name: Referenced Beam Sequence
  Type: 1C
  Attribute Description:

  Sequence of treatment beams in current Fraction Group.

  One or more Items shall be included in this Sequence.

  Required if Number of Beams (300A,0080) is greater than zero.

  
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferencedBeamSequence.Builder<SELF extends ReferencedBeamSequence.Builder<SELF,T>,T extends ReferencedBeamSequence.Holder>
static interface	ReferencedBeamSequence.Holder	A class implementing this interface can hold attributes which contain the DICOM tag "Referenced Beam Sequence" (see ReferencedBeamSequence)
static class	ReferencedBeamSequence.Item
static class	ReferencedBeamSequence.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
ReferencedBeamSequence(org.dcm4che3.data.Sequence sequence)	Creates a new Referenced Beam 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

ReferencedBeamSequence

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

Creates a new Referenced Beam 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<ReferencedBeamSequence,ReferencedBeamSequence.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<ReferencedBeamSequence,ReferencedBeamSequence.Item>

Returns:

The DICOM Tag of the wrapped DICOM sequence.