Package org.dcm4che.typeddicom.dataelements

Interface RTPatientPositionDisplacementSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

RTDeliveryStartPatientPositionSequence.Item, RTTreatmentPreparationPatientPositionSequence.Item

Enclosing class:

RTPatientPositionDisplacementSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTPatientPositionDisplacementSequence.Holder.Builder	builder()
static RTPatientPositionDisplacementSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTPatientPositionDisplacementSequence()
default RTPatientPositionDisplacementSequence	ensureRTPatientPositionDisplacementSequence()	Adds a new RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence) with initial capacity 1 (see ensureRTPatientPositionDisplacementSequence(int)) if it does not already exist.
default RTPatientPositionDisplacementSequence	ensureRTPatientPositionDisplacementSequence(int initialCapacity)	Adds a new RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence) if it does not already exist.
default RTPatientPositionDisplacementSequence	getRTPatientPositionDisplacementSequence()
default RTPatientPositionDisplacementSequence	newRTPatientPositionDisplacementSequence(int initialCapacity)	Adds a new RT Patient Position Displacement Sequence.
default void	removeRTPatientPositionDisplacementSequence()	Removes the RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence
static RTPatientPositionDisplacementSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the RTPatientPositionDisplacementSequence.Holder interface.

builder

static RTPatientPositionDisplacementSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getRTPatientPositionDisplacementSequence

default RTPatientPositionDisplacementSequence getRTPatientPositionDisplacementSequence()

Returns:

the RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence)

newRTPatientPositionDisplacementSequence

default RTPatientPositionDisplacementSequence newRTPatientPositionDisplacementSequence(int initialCapacity)

Adds a new RT Patient Position Displacement Sequence. (see RTPatientPositionDisplacementSequence)

Parameters:

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

Returns:

the newly created RTPatientPositionDisplacementSequence.

ensureRTPatientPositionDisplacementSequence

default RTPatientPositionDisplacementSequence ensureRTPatientPositionDisplacementSequence(int initialCapacity)

Adds a new RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence) 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 Displacement Sequence is created.

Returns:

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

ensureRTPatientPositionDisplacementSequence

default RTPatientPositionDisplacementSequence ensureRTPatientPositionDisplacementSequence()

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

Returns:

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

containsRTPatientPositionDisplacementSequence

default boolean containsRTPatientPositionDisplacementSequence()

Returns:

whether it contains the RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence)

removeRTPatientPositionDisplacementSequence

default void removeRTPatientPositionDisplacementSequence()

Removes the RT Patient Position Displacement Sequence (see RTPatientPositionDisplacementSequence