Package org.dcm4che.typeddicom.dataelements

Interface RTPatientPositionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTDeliveryStartPatientPositionSequence.Item, RTTreatmentPreparationPatientPositionSequence.Item

Enclosing class:

RTPatientPositionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Patient Position Sequence" (see RTPatientPositionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTPatientPositionSequence.Holder.Builder	builder()
static RTPatientPositionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTPatientPositionSequence()
default RTPatientPositionSequence	ensureRTPatientPositionSequence()	Adds a new RT Patient Position Sequence (see RTPatientPositionSequence) with initial capacity 1 (see ensureRTPatientPositionSequence(int)) if it does not already exist.
default RTPatientPositionSequence	ensureRTPatientPositionSequence(int initialCapacity)	Adds a new RT Patient Position Sequence (see RTPatientPositionSequence) if it does not already exist.
default RTPatientPositionSequence	getRTPatientPositionSequence()
default RTPatientPositionSequence	newRTPatientPositionSequence(int initialCapacity)	Adds a new RT Patient Position Sequence.
default void	removeRTPatientPositionSequence()	Removes the RT Patient Position Sequence (see RTPatientPositionSequence
static RTPatientPositionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Patient Position Sequence (see RTPatientPositionSequence)

Returns:

a wrapper object implementing the RTPatientPositionSequence.Holder interface.

builder

static RTPatientPositionSequence.Holder.Builder builder()

Returns:

a RTPatientPositionSequence.Holder.Builder to create RT Patient Position Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getRTPatientPositionSequence

default RTPatientPositionSequence getRTPatientPositionSequence()

Returns:

the RT Patient Position Sequence (see RTPatientPositionSequence)

newRTPatientPositionSequence

default RTPatientPositionSequence newRTPatientPositionSequence(int initialCapacity)

Adds a new RT Patient Position Sequence. (see RTPatientPositionSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Patient Position Sequence

Returns:

the newly created RTPatientPositionSequence.

ensureRTPatientPositionSequence

default RTPatientPositionSequence ensureRTPatientPositionSequence(int initialCapacity)

Adds a new RT Patient Position Sequence (see RTPatientPositionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing RT Patient Position Sequence (see RTPatientPositionSequence) or a new one with capacity initialCapacity.

ensureRTPatientPositionSequence

default RTPatientPositionSequence ensureRTPatientPositionSequence()

Adds a new RT Patient Position Sequence (see RTPatientPositionSequence) with initial capacity 1 (see ensureRTPatientPositionSequence(int)) if it does not already exist.

Returns:

either the already existing RT Patient Position Sequence (see RTPatientPositionSequence) or a new one with capacity 1.

containsRTPatientPositionSequence

default boolean containsRTPatientPositionSequence()

Returns:

whether it contains the RT Patient Position Sequence (see RTPatientPositionSequence)

removeRTPatientPositionSequence

default void removeRTPatientPositionSequence()

Removes the RT Patient Position Sequence (see RTPatientPositionSequence