Package org.dcm4che.typeddicom.dataelements

Interface TreatmentPositionSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTRadiationCommonModule, RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD, TreatmentPositionSequence.SimpleHolder

Enclosing class:

TreatmentPositionSequence

public static interface TreatmentPositionSequence.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentPositionSequence.Holder.Builder	builder()
static TreatmentPositionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentPositionSequence()
default TreatmentPositionSequence	ensureTreatmentPositionSequence()	Adds a new Treatment Position Sequence (see TreatmentPositionSequence) with initial capacity 1 (see ensureTreatmentPositionSequence(int)) if it does not already exist.
default TreatmentPositionSequence	ensureTreatmentPositionSequence(int initialCapacity)	Adds a new Treatment Position Sequence (see TreatmentPositionSequence) if it does not already exist.
default TreatmentPositionSequence	getTreatmentPositionSequence()
default TreatmentPositionSequence	newTreatmentPositionSequence(int initialCapacity)	Adds a new Treatment Position Sequence.
default void	removeTreatmentPositionSequence()	Removes the Treatment Position Sequence (see TreatmentPositionSequence
static TreatmentPositionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Treatment Position Sequence (see TreatmentPositionSequence)

Returns:

A wrapper object implementing the TreatmentPositionSequence.Holder interface.

builder

static TreatmentPositionSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

attributes - The Attributes to be wrapped by the TreatmentPositionSequence.Holder.Builder.

Returns:

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

getTreatmentPositionSequence

default TreatmentPositionSequence getTreatmentPositionSequence()

Returns:

the Treatment Position Sequence (see TreatmentPositionSequence)

newTreatmentPositionSequence

default TreatmentPositionSequence newTreatmentPositionSequence(int initialCapacity)

Adds a new Treatment Position Sequence. (see TreatmentPositionSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Position Sequence

ensureTreatmentPositionSequence

default TreatmentPositionSequence ensureTreatmentPositionSequence(int initialCapacity)

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

Parameters:

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

Returns:

Either the already existing Treatment Position Sequence (see TreatmentPositionSequence) or a new one with capacity initialCapacity.

ensureTreatmentPositionSequence

default TreatmentPositionSequence ensureTreatmentPositionSequence()

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

Returns:

Either the already existing Treatment Position Sequence (see TreatmentPositionSequence) or a new one with capacity 1.

containsTreatmentPositionSequence

default boolean containsTreatmentPositionSequence()

Returns:

Whether it contains the Treatment Position Sequence (see TreatmentPositionSequence)

removeTreatmentPositionSequence

default void removeTreatmentPositionSequence()

Removes the Treatment Position Sequence (see TreatmentPositionSequence