Package org.dcm4che.typeddicom.dataelements

Interface FluenceMapSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTImageModule

All Known Implementing Classes:

RTImageIOD, RTImageModule.SimpleWrapper

Enclosing class:

FluenceMapSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Fluence Map Sequence" (see FluenceMapSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FluenceMapSequence.Holder.Builder	builder()
static FluenceMapSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsFluenceMapSequence()
default FluenceMapSequence	ensureFluenceMapSequence()	Adds a new Fluence Map Sequence (see FluenceMapSequence) with initial capacity 1 (see ensureFluenceMapSequence(int)) if it does not already exist.
default FluenceMapSequence	ensureFluenceMapSequence(int initialCapacity)	Adds a new Fluence Map Sequence (see FluenceMapSequence) if it does not already exist.
default FluenceMapSequence	getFluenceMapSequence()
default FluenceMapSequence	newFluenceMapSequence(int initialCapacity)	Adds a new Fluence Map Sequence.
default void	removeFluenceMapSequence()	Removes the Fluence Map Sequence (see FluenceMapSequence
static FluenceMapSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Fluence Map Sequence (see FluenceMapSequence)

Returns:

a wrapper object implementing the FluenceMapSequence.Holder interface.

builder

static FluenceMapSequence.Holder.Builder builder()

Returns:

a FluenceMapSequence.Holder.Builder to create Fluence Map Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getFluenceMapSequence

default FluenceMapSequence getFluenceMapSequence()

Returns:

the Fluence Map Sequence (see FluenceMapSequence)

newFluenceMapSequence

default FluenceMapSequence newFluenceMapSequence(int initialCapacity)

Adds a new Fluence Map Sequence. (see FluenceMapSequence)

Parameters:

initialCapacity - the initial capacity for the new Fluence Map Sequence

Returns:

the newly created FluenceMapSequence.

ensureFluenceMapSequence

default FluenceMapSequence ensureFluenceMapSequence(int initialCapacity)

Adds a new Fluence Map Sequence (see FluenceMapSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Fluence Map Sequence (see FluenceMapSequence) or a new one with capacity initialCapacity.

ensureFluenceMapSequence

default FluenceMapSequence ensureFluenceMapSequence()

Adds a new Fluence Map Sequence (see FluenceMapSequence) with initial capacity 1 (see ensureFluenceMapSequence(int)) if it does not already exist.

Returns:

either the already existing Fluence Map Sequence (see FluenceMapSequence) or a new one with capacity 1.

containsFluenceMapSequence

default boolean containsFluenceMapSequence()

Returns:

whether it contains the Fluence Map Sequence (see FluenceMapSequence)

removeFluenceMapSequence

default void removeFluenceMapSequence()

Removes the Fluence Map Sequence (see FluenceMapSequence