Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSessionBeamSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBeamsSessionRecordModule

All Known Implementing Classes:

RTBeamsSessionRecordModule.SimpleWrapper, RTBeamsTreatmentRecordIOD

Enclosing class:

TreatmentSessionBeamSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentSessionBeamSequence.Holder.Builder	builder()
static TreatmentSessionBeamSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentSessionBeamSequence()
default TreatmentSessionBeamSequence	ensureTreatmentSessionBeamSequence()	Adds a new Treatment Session Beam Sequence (see TreatmentSessionBeamSequence) with initial capacity 1 (see ensureTreatmentSessionBeamSequence(int)) if it does not already exist.
default TreatmentSessionBeamSequence	ensureTreatmentSessionBeamSequence(int initialCapacity)	Adds a new Treatment Session Beam Sequence (see TreatmentSessionBeamSequence) if it does not already exist.
default TreatmentSessionBeamSequence	getTreatmentSessionBeamSequence()
default TreatmentSessionBeamSequence	newTreatmentSessionBeamSequence(int initialCapacity)	Adds a new Treatment Session Beam Sequence.
default void	removeTreatmentSessionBeamSequence()	Removes the Treatment Session Beam Sequence (see TreatmentSessionBeamSequence
static TreatmentSessionBeamSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the TreatmentSessionBeamSequence.Holder interface.

builder

static TreatmentSessionBeamSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getTreatmentSessionBeamSequence

default TreatmentSessionBeamSequence getTreatmentSessionBeamSequence()

Returns:

the Treatment Session Beam Sequence (see TreatmentSessionBeamSequence)

newTreatmentSessionBeamSequence

default TreatmentSessionBeamSequence newTreatmentSessionBeamSequence(int initialCapacity)

Adds a new Treatment Session Beam Sequence. (see TreatmentSessionBeamSequence)

Parameters:

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

Returns:

the newly created TreatmentSessionBeamSequence.

ensureTreatmentSessionBeamSequence

default TreatmentSessionBeamSequence ensureTreatmentSessionBeamSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureTreatmentSessionBeamSequence

default TreatmentSessionBeamSequence ensureTreatmentSessionBeamSequence()

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

Returns:

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

containsTreatmentSessionBeamSequence

default boolean containsTreatmentSessionBeamSequence()

Returns:

whether it contains the Treatment Session Beam Sequence (see TreatmentSessionBeamSequence)

removeTreatmentSessionBeamSequence

default void removeTreatmentSessionBeamSequence()

Removes the Treatment Session Beam Sequence (see TreatmentSessionBeamSequence