Package org.dcm4che.typeddicom.dataelements

Interface GatedInformationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

NMMultiGatedAcquisitionModule

All Known Implementing Classes:

NMMultiGatedAcquisitionModule.SimpleWrapper, NuclearMedicineImageIOD

Enclosing class:

GatedInformationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Gated Information Sequence" (see GatedInformationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GatedInformationSequence.Holder.Builder	builder()
static GatedInformationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsGatedInformationSequence()
default GatedInformationSequence	ensureGatedInformationSequence()	Adds a new Gated Information Sequence (see GatedInformationSequence) with initial capacity 1 (see ensureGatedInformationSequence(int)) if it does not already exist.
default GatedInformationSequence	ensureGatedInformationSequence(int initialCapacity)	Adds a new Gated Information Sequence (see GatedInformationSequence) if it does not already exist.
default GatedInformationSequence	getGatedInformationSequence()
default GatedInformationSequence	newGatedInformationSequence(int initialCapacity)	Adds a new Gated Information Sequence.
default void	removeGatedInformationSequence()	Removes the Gated Information Sequence (see GatedInformationSequence
static GatedInformationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Gated Information Sequence (see GatedInformationSequence)

Returns:

a wrapper object implementing the GatedInformationSequence.Holder interface.

builder

static GatedInformationSequence.Holder.Builder builder()

Returns:

a GatedInformationSequence.Holder.Builder to create Gated Information Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a GatedInformationSequence.Holder.Builder to create Gated Information Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getGatedInformationSequence

default GatedInformationSequence getGatedInformationSequence()

Returns:

the Gated Information Sequence (see GatedInformationSequence)

newGatedInformationSequence

default GatedInformationSequence newGatedInformationSequence(int initialCapacity)

Adds a new Gated Information Sequence. (see GatedInformationSequence)

Parameters:

initialCapacity - the initial capacity for the new Gated Information Sequence

Returns:

the newly created GatedInformationSequence.

ensureGatedInformationSequence

default GatedInformationSequence ensureGatedInformationSequence(int initialCapacity)

Adds a new Gated Information Sequence (see GatedInformationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Gated Information Sequence (see GatedInformationSequence) or a new one with capacity initialCapacity.

ensureGatedInformationSequence

default GatedInformationSequence ensureGatedInformationSequence()

Adds a new Gated Information Sequence (see GatedInformationSequence) with initial capacity 1 (see ensureGatedInformationSequence(int)) if it does not already exist.

Returns:

either the already existing Gated Information Sequence (see GatedInformationSequence) or a new one with capacity 1.

containsGatedInformationSequence

default boolean containsGatedInformationSequence()

Returns:

whether it contains the Gated Information Sequence (see GatedInformationSequence)

removeGatedInformationSequence

default void removeGatedInformationSequence()

Removes the Gated Information Sequence (see GatedInformationSequence