Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSessionIonBeamSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTIonBeamsSessionRecordModule

All Known Implementing Classes:

RTIonBeamsTreatmentRecordIOD, TreatmentSessionIonBeamSequence.SimpleHolder

Enclosing class:

TreatmentSessionIonBeamSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Session Ion Beam Sequence" (see TreatmentSessionIonBeamSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentSessionIonBeamSequence.Holder.Builder	builder()
static TreatmentSessionIonBeamSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentSessionIonBeamSequence()
default TreatmentSessionIonBeamSequence	ensureTreatmentSessionIonBeamSequence()	Adds a new Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) with initial capacity 1 (see ensureTreatmentSessionIonBeamSequence(int)) if it does not already exist.
default TreatmentSessionIonBeamSequence	ensureTreatmentSessionIonBeamSequence(int initialCapacity)	Adds a new Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) if it does not already exist.
default TreatmentSessionIonBeamSequence	getTreatmentSessionIonBeamSequence()
default TreatmentSessionIonBeamSequence	newTreatmentSessionIonBeamSequence(int initialCapacity)	Adds a new Treatment Session Ion Beam Sequence.
default void	removeTreatmentSessionIonBeamSequence()	Removes the Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence
static TreatmentSessionIonBeamSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence)

Returns:

a wrapper object implementing the TreatmentSessionIonBeamSequence.Holder interface.

builder

static TreatmentSessionIonBeamSequence.Holder.Builder builder()

Returns:

a TreatmentSessionIonBeamSequence.Holder.Builder to create Treatment Session Ion Beam Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentSessionIonBeamSequence.Holder.Builder to create Treatment Session Ion Beam Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentSessionIonBeamSequence

default TreatmentSessionIonBeamSequence getTreatmentSessionIonBeamSequence()

Returns:

the Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence)

newTreatmentSessionIonBeamSequence

default TreatmentSessionIonBeamSequence newTreatmentSessionIonBeamSequence(int initialCapacity)

Adds a new Treatment Session Ion Beam Sequence. (see TreatmentSessionIonBeamSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Session Ion Beam Sequence

Returns:

the newly created TreatmentSessionIonBeamSequence.

ensureTreatmentSessionIonBeamSequence

default TreatmentSessionIonBeamSequence ensureTreatmentSessionIonBeamSequence(int initialCapacity)

Adds a new Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Session Ion Beam Sequence is created.

Returns:

either the already existing Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) or a new one with capacity initialCapacity.

ensureTreatmentSessionIonBeamSequence

default TreatmentSessionIonBeamSequence ensureTreatmentSessionIonBeamSequence()

Adds a new Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) with initial capacity 1 (see ensureTreatmentSessionIonBeamSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence) or a new one with capacity 1.

containsTreatmentSessionIonBeamSequence

default boolean containsTreatmentSessionIonBeamSequence()

Returns:

whether it contains the Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence)

removeTreatmentSessionIonBeamSequence

default void removeTreatmentSessionIonBeamSequence()

Removes the Treatment Session Ion Beam Sequence (see TreatmentSessionIonBeamSequence