Package org.dcm4che.typeddicom.dataelements

Interface RTRadiationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationSetModule

All Known Implementing Classes:

RTRadiationSequence.SimpleHolder, RTRadiationSetIOD

Enclosing class:

RTRadiationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Radiation Sequence" (see RTRadiationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTRadiationSequence.Holder.Builder	builder()
static RTRadiationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTRadiationSequence()
default RTRadiationSequence	ensureRTRadiationSequence()	Adds a new RT Radiation Sequence (see RTRadiationSequence) with initial capacity 1 (see ensureRTRadiationSequence(int)) if it does not already exist.
default RTRadiationSequence	ensureRTRadiationSequence(int initialCapacity)	Adds a new RT Radiation Sequence (see RTRadiationSequence) if it does not already exist.
default RTRadiationSequence	getRTRadiationSequence()
default RTRadiationSequence	newRTRadiationSequence(int initialCapacity)	Adds a new RT Radiation Sequence.
default void	removeRTRadiationSequence()	Removes the RT Radiation Sequence (see RTRadiationSequence
static RTRadiationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Radiation Sequence (see RTRadiationSequence)

Returns:

a wrapper object implementing the RTRadiationSequence.Holder interface.

builder

static RTRadiationSequence.Holder.Builder builder()

Returns:

a RTRadiationSequence.Holder.Builder to create RT Radiation Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTRadiationSequence

default RTRadiationSequence getRTRadiationSequence()

Returns:

the RT Radiation Sequence (see RTRadiationSequence)

newRTRadiationSequence

default RTRadiationSequence newRTRadiationSequence(int initialCapacity)

Adds a new RT Radiation Sequence. (see RTRadiationSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Radiation Sequence

Returns:

the newly created RTRadiationSequence.

ensureRTRadiationSequence

default RTRadiationSequence ensureRTRadiationSequence(int initialCapacity)

Adds a new RT Radiation Sequence (see RTRadiationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing RT Radiation Sequence (see RTRadiationSequence) or a new one with capacity initialCapacity.

ensureRTRadiationSequence

default RTRadiationSequence ensureRTRadiationSequence()

Adds a new RT Radiation Sequence (see RTRadiationSequence) with initial capacity 1 (see ensureRTRadiationSequence(int)) if it does not already exist.

Returns:

either the already existing RT Radiation Sequence (see RTRadiationSequence) or a new one with capacity 1.

containsRTRadiationSequence

default boolean containsRTRadiationSequence()

Returns:

whether it contains the RT Radiation Sequence (see RTRadiationSequence)

removeRTRadiationSequence

default void removeRTRadiationSequence()

Removes the RT Radiation Sequence (see RTRadiationSequence