Package org.dcm4che.typeddicom.dataelements

Interface UsedFiducialsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

DeformableRegistrationSequence.Item, RegistrationSequence.Item, UsedFiducialsSequence.SimpleHolder

Enclosing class:

UsedFiducialsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Used Fiducials Sequence" (see UsedFiducialsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UsedFiducialsSequence.Holder.Builder	builder()
static UsedFiducialsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsUsedFiducialsSequence()
default UsedFiducialsSequence	ensureUsedFiducialsSequence()	Adds a new Used Fiducials Sequence (see UsedFiducialsSequence) with initial capacity 1 (see ensureUsedFiducialsSequence(int)) if it does not already exist.
default UsedFiducialsSequence	ensureUsedFiducialsSequence(int initialCapacity)	Adds a new Used Fiducials Sequence (see UsedFiducialsSequence) if it does not already exist.
default UsedFiducialsSequence	getUsedFiducialsSequence()
default UsedFiducialsSequence	newUsedFiducialsSequence(int initialCapacity)	Adds a new Used Fiducials Sequence.
default void	removeUsedFiducialsSequence()	Removes the Used Fiducials Sequence (see UsedFiducialsSequence
static UsedFiducialsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Used Fiducials Sequence (see UsedFiducialsSequence)

Returns:

a wrapper object implementing the UsedFiducialsSequence.Holder interface.

builder

static UsedFiducialsSequence.Holder.Builder builder()

Returns:

a UsedFiducialsSequence.Holder.Builder to create Used Fiducials Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a UsedFiducialsSequence.Holder.Builder to create Used Fiducials Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getUsedFiducialsSequence

default UsedFiducialsSequence getUsedFiducialsSequence()

Returns:

the Used Fiducials Sequence (see UsedFiducialsSequence)

newUsedFiducialsSequence

default UsedFiducialsSequence newUsedFiducialsSequence(int initialCapacity)

Adds a new Used Fiducials Sequence. (see UsedFiducialsSequence)

Parameters:

initialCapacity - the initial capacity for the new Used Fiducials Sequence

Returns:

the newly created UsedFiducialsSequence.

ensureUsedFiducialsSequence

default UsedFiducialsSequence ensureUsedFiducialsSequence(int initialCapacity)

Adds a new Used Fiducials Sequence (see UsedFiducialsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Used Fiducials Sequence is created.

Returns:

either the already existing Used Fiducials Sequence (see UsedFiducialsSequence) or a new one with capacity initialCapacity.

ensureUsedFiducialsSequence

default UsedFiducialsSequence ensureUsedFiducialsSequence()

Adds a new Used Fiducials Sequence (see UsedFiducialsSequence) with initial capacity 1 (see ensureUsedFiducialsSequence(int)) if it does not already exist.

Returns:

either the already existing Used Fiducials Sequence (see UsedFiducialsSequence) or a new one with capacity 1.

containsUsedFiducialsSequence

default boolean containsUsedFiducialsSequence()

Returns:

whether it contains the Used Fiducials Sequence (see UsedFiducialsSequence)

removeUsedFiducialsSequence

default void removeUsedFiducialsSequence()

Removes the Used Fiducials Sequence (see UsedFiducialsSequence