Package org.dcm4che.typeddicom.dataelements

Interface IonBeamSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTIonBeamsModule

All Known Implementing Classes:

RTIonBeamsModule.SimpleWrapper, RTIonPlanIOD

Enclosing class:

IonBeamSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static IonBeamSequence.Holder.Builder	builder()
static IonBeamSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsIonBeamSequence()
default IonBeamSequence	ensureIonBeamSequence()	Adds a new Ion Beam Sequence (see IonBeamSequence) with initial capacity 1 (see ensureIonBeamSequence(int)) if it does not already exist.
default IonBeamSequence	ensureIonBeamSequence(int initialCapacity)	Adds a new Ion Beam Sequence (see IonBeamSequence) if it does not already exist.
default IonBeamSequence	getIonBeamSequence()
default IonBeamSequence	newIonBeamSequence(int initialCapacity)	Adds a new Ion Beam Sequence.
default void	removeIonBeamSequence()	Removes the Ion Beam Sequence (see IonBeamSequence
static IonBeamSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Ion Beam Sequence (see IonBeamSequence)

Returns:

a wrapper object implementing the IonBeamSequence.Holder interface.

builder

static IonBeamSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getIonBeamSequence

default IonBeamSequence getIonBeamSequence()

Returns:

the Ion Beam Sequence (see IonBeamSequence)

newIonBeamSequence

default IonBeamSequence newIonBeamSequence(int initialCapacity)

Adds a new Ion Beam Sequence. (see IonBeamSequence)

Parameters:

initialCapacity - the initial capacity for the new Ion Beam Sequence

Returns:

the newly created IonBeamSequence.

ensureIonBeamSequence

default IonBeamSequence ensureIonBeamSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureIonBeamSequence

default IonBeamSequence ensureIonBeamSequence()

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

Returns:

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

containsIonBeamSequence

default boolean containsIonBeamSequence()

Returns:

whether it contains the Ion Beam Sequence (see IonBeamSequence)

removeIonBeamSequence

default void removeIonBeamSequence()

Removes the Ion Beam Sequence (see IonBeamSequence