Package org.dcm4che.typeddicom.dataelements

Interface RTROIObservationsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTROIObservationsModule

All Known Implementing Classes:

RTROIObservationsModule.SimpleWrapper, RTStructureSetIOD

Enclosing class:

RTROIObservationsSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTROIObservationsSequence.Holder.Builder	builder()
static RTROIObservationsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTROIObservationsSequence()
default RTROIObservationsSequence	ensureRTROIObservationsSequence()	Adds a new RT ROI Observations Sequence (see RTROIObservationsSequence) with initial capacity 1 (see ensureRTROIObservationsSequence(int)) if it does not already exist.
default RTROIObservationsSequence	ensureRTROIObservationsSequence(int initialCapacity)	Adds a new RT ROI Observations Sequence (see RTROIObservationsSequence) if it does not already exist.
default RTROIObservationsSequence	getRTROIObservationsSequence()
default RTROIObservationsSequence	newRTROIObservationsSequence(int initialCapacity)	Adds a new RT ROI Observations Sequence.
default void	removeRTROIObservationsSequence()	Removes the RT ROI Observations Sequence (see RTROIObservationsSequence
static RTROIObservationsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT ROI Observations Sequence (see RTROIObservationsSequence)

Returns:

a wrapper object implementing the RTROIObservationsSequence.Holder interface.

builder

static RTROIObservationsSequence.Holder.Builder builder()

Returns:

a RTROIObservationsSequence.Holder.Builder to create RT ROI Observations Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTROIObservationsSequence

default RTROIObservationsSequence getRTROIObservationsSequence()

Returns:

the RT ROI Observations Sequence (see RTROIObservationsSequence)

newRTROIObservationsSequence

default RTROIObservationsSequence newRTROIObservationsSequence(int initialCapacity)

Adds a new RT ROI Observations Sequence. (see RTROIObservationsSequence)

Parameters:

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

Returns:

the newly created RTROIObservationsSequence.

ensureRTROIObservationsSequence

default RTROIObservationsSequence ensureRTROIObservationsSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureRTROIObservationsSequence

default RTROIObservationsSequence ensureRTROIObservationsSequence()

Adds a new RT ROI Observations Sequence (see RTROIObservationsSequence) with initial capacity 1 (see ensureRTROIObservationsSequence(int)) if it does not already exist.

Returns:

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

containsRTROIObservationsSequence

default boolean containsRTROIObservationsSequence()

Returns:

whether it contains the RT ROI Observations Sequence (see RTROIObservationsSequence)

removeRTROIObservationsSequence

default void removeRTROIObservationsSequence()

Removes the RT ROI Observations Sequence (see RTROIObservationsSequence