Package org.dcm4che.typeddicom.dataelements

Interface RTDoseROISequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDoseROIModule

All Known Implementing Classes:

RTDoseIOD, RTDoseROISequence.SimpleHolder

Enclosing class:

RTDoseROISequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Dose ROI Sequence" (see RTDoseROISequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTDoseROISequence.Holder.Builder	builder()
static RTDoseROISequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTDoseROISequence()
default RTDoseROISequence	ensureRTDoseROISequence()	Adds a new RT Dose ROI Sequence (see RTDoseROISequence) with initial capacity 1 (see ensureRTDoseROISequence(int)) if it does not already exist.
default RTDoseROISequence	ensureRTDoseROISequence(int initialCapacity)	Adds a new RT Dose ROI Sequence (see RTDoseROISequence) if it does not already exist.
default RTDoseROISequence	getRTDoseROISequence()
default RTDoseROISequence	newRTDoseROISequence(int initialCapacity)	Adds a new RT Dose ROI Sequence.
default void	removeRTDoseROISequence()	Removes the RT Dose ROI Sequence (see RTDoseROISequence
static RTDoseROISequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Dose ROI Sequence (see RTDoseROISequence)

Returns:

a wrapper object implementing the RTDoseROISequence.Holder interface.

builder

static RTDoseROISequence.Holder.Builder builder()

Returns:

a RTDoseROISequence.Holder.Builder to create RT Dose ROI Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTDoseROISequence

default RTDoseROISequence getRTDoseROISequence()

Returns:

the RT Dose ROI Sequence (see RTDoseROISequence)

newRTDoseROISequence

default RTDoseROISequence newRTDoseROISequence(int initialCapacity)

Adds a new RT Dose ROI Sequence. (see RTDoseROISequence)

Parameters:

initialCapacity - the initial capacity for the new RT Dose ROI Sequence

Returns:

the newly created RTDoseROISequence.

ensureRTDoseROISequence

default RTDoseROISequence ensureRTDoseROISequence(int initialCapacity)

Adds a new RT Dose ROI Sequence (see RTDoseROISequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing RT Dose ROI Sequence (see RTDoseROISequence) or a new one with capacity initialCapacity.

ensureRTDoseROISequence

default RTDoseROISequence ensureRTDoseROISequence()

Adds a new RT Dose ROI Sequence (see RTDoseROISequence) with initial capacity 1 (see ensureRTDoseROISequence(int)) if it does not already exist.

Returns:

either the already existing RT Dose ROI Sequence (see RTDoseROISequence) or a new one with capacity 1.

containsRTDoseROISequence

default boolean containsRTDoseROISequence()

Returns:

whether it contains the RT Dose ROI Sequence (see RTDoseROISequence)

removeRTDoseROISequence

default void removeRTDoseROISequence()

Removes the RT Dose ROI Sequence (see RTDoseROISequence