Package org.dcm4che.typeddicom.dataelements

Interface BeamTaskSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBeamsDeliveryInstructionModule

All Known Implementing Classes:

BeamTaskSequence.SimpleHolder, RTBeamsDeliveryInstructionIOD

Enclosing class:

BeamTaskSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Beam Task Sequence" (see BeamTaskSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamTaskSequence.Holder.Builder	builder()
static BeamTaskSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamTaskSequence()
default BeamTaskSequence	ensureBeamTaskSequence()	Adds a new Beam Task Sequence (see BeamTaskSequence) with initial capacity 1 (see ensureBeamTaskSequence(int)) if it does not already exist.
default BeamTaskSequence	ensureBeamTaskSequence(int initialCapacity)	Adds a new Beam Task Sequence (see BeamTaskSequence) if it does not already exist.
default BeamTaskSequence	getBeamTaskSequence()
default BeamTaskSequence	newBeamTaskSequence(int initialCapacity)	Adds a new Beam Task Sequence.
default void	removeBeamTaskSequence()	Removes the Beam Task Sequence (see BeamTaskSequence
static BeamTaskSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Beam Task Sequence (see BeamTaskSequence)

Returns:

a wrapper object implementing the BeamTaskSequence.Holder interface.

builder

static BeamTaskSequence.Holder.Builder builder()

Returns:

a BeamTaskSequence.Holder.Builder to create Beam Task Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBeamTaskSequence

default BeamTaskSequence getBeamTaskSequence()

Returns:

the Beam Task Sequence (see BeamTaskSequence)

newBeamTaskSequence

default BeamTaskSequence newBeamTaskSequence(int initialCapacity)

Adds a new Beam Task Sequence. (see BeamTaskSequence)

Parameters:

initialCapacity - the initial capacity for the new Beam Task Sequence

Returns:

the newly created BeamTaskSequence.

ensureBeamTaskSequence

default BeamTaskSequence ensureBeamTaskSequence(int initialCapacity)

Adds a new Beam Task Sequence (see BeamTaskSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Beam Task Sequence (see BeamTaskSequence) or a new one with capacity initialCapacity.

ensureBeamTaskSequence

default BeamTaskSequence ensureBeamTaskSequence()

Adds a new Beam Task Sequence (see BeamTaskSequence) with initial capacity 1 (see ensureBeamTaskSequence(int)) if it does not already exist.

Returns:

either the already existing Beam Task Sequence (see BeamTaskSequence) or a new one with capacity 1.

containsBeamTaskSequence

default boolean containsBeamTaskSequence()

Returns:

whether it contains the Beam Task Sequence (see BeamTaskSequence)

removeBeamTaskSequence

default void removeBeamTaskSequence()

Removes the Beam Task Sequence (see BeamTaskSequence