Package org.dcm4che.typeddicom.dataelements

Interface RTPatientPositionScopeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTTreatmentPreparationModule

All Known Implementing Classes:

RTTreatmentPreparationIOD, RTTreatmentPreparationModule.SimpleWrapper

Enclosing class:

RTPatientPositionScopeSequence

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

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTPatientPositionScopeSequence.Holder.Builder	builder()
static RTPatientPositionScopeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTPatientPositionScopeSequence()
default RTPatientPositionScopeSequence	ensureRTPatientPositionScopeSequence()	Adds a new RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence) with initial capacity 1 (see ensureRTPatientPositionScopeSequence(int)) if it does not already exist.
default RTPatientPositionScopeSequence	ensureRTPatientPositionScopeSequence(int initialCapacity)	Adds a new RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence) if it does not already exist.
default RTPatientPositionScopeSequence	getRTPatientPositionScopeSequence()
default RTPatientPositionScopeSequence	newRTPatientPositionScopeSequence(int initialCapacity)	Adds a new RT Patient Position Scope Sequence.
default void	removeRTPatientPositionScopeSequence()	Removes the RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence
static RTPatientPositionScopeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

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

Returns:

a wrapper object implementing the RTPatientPositionScopeSequence.Holder interface.

builder

static RTPatientPositionScopeSequence.Holder.Builder builder()

Returns:

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

builder

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

Parameters:

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

Returns:

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

getRTPatientPositionScopeSequence

default RTPatientPositionScopeSequence getRTPatientPositionScopeSequence()

Returns:

the RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence)

newRTPatientPositionScopeSequence

default RTPatientPositionScopeSequence newRTPatientPositionScopeSequence(int initialCapacity)

Adds a new RT Patient Position Scope Sequence. (see RTPatientPositionScopeSequence)

Parameters:

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

Returns:

the newly created RTPatientPositionScopeSequence.

ensureRTPatientPositionScopeSequence

default RTPatientPositionScopeSequence ensureRTPatientPositionScopeSequence(int initialCapacity)

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

Returns:

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

ensureRTPatientPositionScopeSequence

default RTPatientPositionScopeSequence ensureRTPatientPositionScopeSequence()

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

Returns:

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

containsRTPatientPositionScopeSequence

default boolean containsRTPatientPositionScopeSequence()

Returns:

whether it contains the RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence)

removeRTPatientPositionScopeSequence

default void removeRTPatientPositionScopeSequence()

Removes the RT Patient Position Scope Sequence (see RTPatientPositionScopeSequence