Package org.dcm4che.typeddicom.dataelements

Interface PrimaryFluenceModeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, ExposureSequence.Item, PrimaryFluenceModeSequence.SimpleHolder, TreatmentSessionBeamSequence.Item

Enclosing class:

PrimaryFluenceModeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Primary Fluence Mode Sequence" (see PrimaryFluenceModeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PrimaryFluenceModeSequence.Holder.Builder	builder()
static PrimaryFluenceModeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPrimaryFluenceModeSequence()
default PrimaryFluenceModeSequence	ensurePrimaryFluenceModeSequence()	Adds a new Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) with initial capacity 1 (see ensurePrimaryFluenceModeSequence(int)) if it does not already exist.
default PrimaryFluenceModeSequence	ensurePrimaryFluenceModeSequence(int initialCapacity)	Adds a new Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) if it does not already exist.
default PrimaryFluenceModeSequence	getPrimaryFluenceModeSequence()
default PrimaryFluenceModeSequence	newPrimaryFluenceModeSequence(int initialCapacity)	Adds a new Primary Fluence Mode Sequence.
default void	removePrimaryFluenceModeSequence()	Removes the Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence
static PrimaryFluenceModeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence)

Returns:

a wrapper object implementing the PrimaryFluenceModeSequence.Holder interface.

builder

static PrimaryFluenceModeSequence.Holder.Builder builder()

Returns:

a PrimaryFluenceModeSequence.Holder.Builder to create Primary Fluence Mode Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPrimaryFluenceModeSequence

default PrimaryFluenceModeSequence getPrimaryFluenceModeSequence()

Returns:

the Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence)

newPrimaryFluenceModeSequence

default PrimaryFluenceModeSequence newPrimaryFluenceModeSequence(int initialCapacity)

Adds a new Primary Fluence Mode Sequence. (see PrimaryFluenceModeSequence)

Parameters:

initialCapacity - the initial capacity for the new Primary Fluence Mode Sequence

Returns:

the newly created PrimaryFluenceModeSequence.

ensurePrimaryFluenceModeSequence

default PrimaryFluenceModeSequence ensurePrimaryFluenceModeSequence(int initialCapacity)

Adds a new Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) or a new one with capacity initialCapacity.

ensurePrimaryFluenceModeSequence

default PrimaryFluenceModeSequence ensurePrimaryFluenceModeSequence()

Adds a new Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) with initial capacity 1 (see ensurePrimaryFluenceModeSequence(int)) if it does not already exist.

Returns:

either the already existing Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence) or a new one with capacity 1.

containsPrimaryFluenceModeSequence

default boolean containsPrimaryFluenceModeSequence()

Returns:

whether it contains the Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence)

removePrimaryFluenceModeSequence

default void removePrimaryFluenceModeSequence()

Removes the Primary Fluence Mode Sequence (see PrimaryFluenceModeSequence