PlanOverviewSequence (dcm4che-typeddicom-lib-std 0.5.2 API)

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

All Implemented Interfaces:

java.lang.Iterable<PlanOverviewSequence.Item>, java.util.Collection<PlanOverviewSequence.Item>, java.util.List<PlanOverviewSequence.Item>
```
public class PlanOverviewSequence
extends org.dcm4che.typeddicom.SequenceWrapper<PlanOverviewSequence,PlanOverviewSequence.Item>
```
Name: Plan Overview Sequence
Keyword: PlanOverviewSequence
Tag: (300C,0116)
Value Representation: Sequence
Value Multiplicity: 1
- Described in the contexts:
  - RT Dose Module > Plan Overview Sequence
  as follows:
  Attribute Name: Plan Overview Sequence
  Type: 1C
  Attribute Description:
  Parameters providing an overview of the plan used to create this RT Dose Instance.
  
  Required if Dose Summation Type (3004,000A) is PLAN_OVERVIEW. May be present if Dose Summation Type (3004,000A) is PLAN, MULTI_PLAN or RECORD.
  
  One or more Items shall be included in this Sequence if Dose Summation Type (3004,000A) is PLAN_OVERVIEW.
  
  Only one Item shall be included in this Sequence if Dose Summation Type (3004,000A) is PLAN or RECORD.
  
  Two or more Items shall be included in this Sequence if Dose Summation Type (3004,000A) is MULTI_PLAN.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`PlanOverviewSequence.Builder<SELF extends PlanOverviewSequence.Builder<SELF,T>,T extends PlanOverviewSequence.Holder>`
`static interface`	`PlanOverviewSequence.Holder`	A class implementing this interface can hold attributes which contain the DICOM tag "Plan Overview Sequence" (see `PlanOverviewSequence`)
`static class`	`PlanOverviewSequence.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

PlanOverviewSequence(org.dcm4che3.data.Sequence sequence)
Creates a new Plan Overview 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
  - PlanOverviewSequence
```
public PlanOverviewSequence(org.dcm4che3.data.Sequence sequence)
```
    Creates a new Plan Overview 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<PlanOverviewSequence,PlanOverviewSequence.Item>
  - getTag
```
public int getTag()
```
    Specified by:
    
    getTag in class org.dcm4che.typeddicom.SequenceWrapper<PlanOverviewSequence,PlanOverviewSequence.Item>