Package org.dcm4che.typeddicom.dataelements

Interface ReferencedRTRadiationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

OmittedRadiationSequence.Item, RadiationDoseSequence.Item, ReferencedRTRadiationSequence.SimpleHolder, ReferencedRTRadiationSetSequence.Item, RTPatientPositionScopeSequence.Item, RTRadiationTaskSequence.Item, TreatmentPositionGroupSequence.Item

Enclosing class:

ReferencedRTRadiationSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedRTRadiationSequence.Holder.Builder	builder()
static ReferencedRTRadiationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedRTRadiationSequence()
default ReferencedRTRadiationSequence	ensureReferencedRTRadiationSequence()	Adds a new Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence) with initial capacity 1 (see ensureReferencedRTRadiationSequence(int)) if it does not already exist.
default ReferencedRTRadiationSequence	ensureReferencedRTRadiationSequence(int initialCapacity)	Adds a new Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence) if it does not already exist.
default ReferencedRTRadiationSequence	getReferencedRTRadiationSequence()
default ReferencedRTRadiationSequence	newReferencedRTRadiationSequence(int initialCapacity)	Adds a new Referenced RT Radiation Sequence.
default void	removeReferencedRTRadiationSequence()	Removes the Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence
static ReferencedRTRadiationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the ReferencedRTRadiationSequence.Holder interface.

builder

static ReferencedRTRadiationSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getReferencedRTRadiationSequence

default ReferencedRTRadiationSequence getReferencedRTRadiationSequence()

Returns:

the Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence)

newReferencedRTRadiationSequence

default ReferencedRTRadiationSequence newReferencedRTRadiationSequence(int initialCapacity)

Adds a new Referenced RT Radiation Sequence. (see ReferencedRTRadiationSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced RT Radiation Sequence

Returns:

the newly created ReferencedRTRadiationSequence.

ensureReferencedRTRadiationSequence

default ReferencedRTRadiationSequence ensureReferencedRTRadiationSequence(int initialCapacity)

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

Parameters:

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

Returns:

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

ensureReferencedRTRadiationSequence

default ReferencedRTRadiationSequence ensureReferencedRTRadiationSequence()

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

Returns:

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

containsReferencedRTRadiationSequence

default boolean containsReferencedRTRadiationSequence()

Returns:

whether it contains the Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence)

removeReferencedRTRadiationSequence

default void removeReferencedRTRadiationSequence()

Removes the Referenced RT Radiation Sequence (see ReferencedRTRadiationSequence