Package org.dcm4che.typeddicom.dataelements

Interface TreatmentPositionGroupSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationSetModule

All Known Implementing Classes:

ReferencedRTRadiationSetSequence.Item, RTRadiationSetIOD, RTRadiationSetModule.SimpleWrapper

Enclosing class:

TreatmentPositionGroupSequence

public static interface TreatmentPositionGroupSequence.Holder
extends org.dcm4che.typeddicom.AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Position Group Sequence" (see TreatmentPositionGroupSequence)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TreatmentPositionGroupSequence.Holder.Builder

Method Summary

Modifier and Type	Method	Description
static TreatmentPositionGroupSequence.Holder.Builder	builder()
static TreatmentPositionGroupSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentPositionGroupSequence()
default TreatmentPositionGroupSequence	ensureTreatmentPositionGroupSequence()	Adds a new Treatment Position Group Sequence (see TreatmentPositionGroupSequence) with initial capacity 1 (see ensureTreatmentPositionGroupSequence(int)) if it does not already exist.
default TreatmentPositionGroupSequence	ensureTreatmentPositionGroupSequence(int initialCapacity)	Adds a new Treatment Position Group Sequence (see TreatmentPositionGroupSequence) if it does not already exist.
default TreatmentPositionGroupSequence	getTreatmentPositionGroupSequence()
default TreatmentPositionGroupSequence	newTreatmentPositionGroupSequence(int initialCapacity)	Adds a new Treatment Position Group Sequence.
default void	removeTreatmentPositionGroupSequence()	Removes the Treatment Position Group Sequence (see TreatmentPositionGroupSequence
static TreatmentPositionGroupSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

static TreatmentPositionGroupSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - an attributes object containing the Treatment Position Group Sequence (see TreatmentPositionGroupSequence)

Returns:

a wrapper object implementing the TreatmentPositionGroupSequence.Holder interface.

builder

static TreatmentPositionGroupSequence.Holder.Builder builder()

Returns:

a TreatmentPositionGroupSequence.Holder.Builder to create Treatment Position Group Sequence Items with a fluent API.

builder

static TreatmentPositionGroupSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)

Parameters:

attributes - the Attributes to be wrapped by the TreatmentPositionGroupSequence.Holder.Builder.

Returns:

a TreatmentPositionGroupSequence.Holder.Builder to create Treatment Position Group Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentPositionGroupSequence

default TreatmentPositionGroupSequence getTreatmentPositionGroupSequence()

Returns:

the Treatment Position Group Sequence (see TreatmentPositionGroupSequence)

newTreatmentPositionGroupSequence

default TreatmentPositionGroupSequence newTreatmentPositionGroupSequence(int initialCapacity)

Adds a new Treatment Position Group Sequence. (see TreatmentPositionGroupSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Position Group Sequence

Returns:

the newly created TreatmentPositionGroupSequence.

ensureTreatmentPositionGroupSequence

default TreatmentPositionGroupSequence ensureTreatmentPositionGroupSequence(int initialCapacity)

Adds a new Treatment Position Group Sequence (see TreatmentPositionGroupSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Position Group Sequence is created.

Returns:

either the already existing Treatment Position Group Sequence (see TreatmentPositionGroupSequence) or a new one with capacity initialCapacity.

ensureTreatmentPositionGroupSequence

default TreatmentPositionGroupSequence ensureTreatmentPositionGroupSequence()

Adds a new Treatment Position Group Sequence (see TreatmentPositionGroupSequence) with initial capacity 1 (see ensureTreatmentPositionGroupSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Position Group Sequence (see TreatmentPositionGroupSequence) or a new one with capacity 1.

containsTreatmentPositionGroupSequence

default boolean containsTreatmentPositionGroupSequence()

Returns:

whether it contains the Treatment Position Group Sequence (see TreatmentPositionGroupSequence)

removeTreatmentPositionGroupSequence

default void removeTreatmentPositionGroupSequence()

Removes the Treatment Position Group Sequence (see TreatmentPositionGroupSequence