Package org.dcm4che.typeddicom.dataelements

Interface BeamSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBeamsModule

All Known Implementing Classes:

BeamSequence.SimpleHolder, RTPlanIOD

Enclosing class:

BeamSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamSequence.Holder.Builder	builder()
static BeamSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamSequence()
default BeamSequence	ensureBeamSequence()	Adds a new Beam Sequence (see BeamSequence) with initial capacity 1 (see ensureBeamSequence(int)) if it does not already exist.
default BeamSequence	ensureBeamSequence(int initialCapacity)	Adds a new Beam Sequence (see BeamSequence) if it does not already exist.
default BeamSequence	getBeamSequence()
default BeamSequence	newBeamSequence(int initialCapacity)	Adds a new Beam Sequence.
default void	removeBeamSequence()	Removes the Beam Sequence (see BeamSequence
static BeamSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Beam Sequence (see BeamSequence)

Returns:

a wrapper object implementing the BeamSequence.Holder interface.

builder

static BeamSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getBeamSequence

default BeamSequence getBeamSequence()

Returns:

the Beam Sequence (see BeamSequence)

newBeamSequence

default BeamSequence newBeamSequence(int initialCapacity)

Adds a new Beam Sequence. (see BeamSequence)

Parameters:

initialCapacity - the initial capacity for the new Beam Sequence

Returns:

the newly created BeamSequence.

ensureBeamSequence

default BeamSequence ensureBeamSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureBeamSequence

default BeamSequence ensureBeamSequence()

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

Returns:

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

containsBeamSequence

default boolean containsBeamSequence()

Returns:

whether it contains the Beam Sequence (see BeamSequence)

removeBeamSequence

default void removeBeamSequence()

Removes the Beam Sequence (see BeamSequence