Package org.dcm4che.typeddicom.dataelements

Interface PerFrameFunctionalGroupsSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

MultiFrameFunctionalGroupsModule

All Known Implementing Classes:

BreastProjectionXRayImageIOD, BreastTomosynthesisImageIOD, EnhancedCTImageIOD, EnhancedMRColorImageIOD, EnhancedMRImageIOD, EnhancedPETImageIOD, EnhancedUSVolumeIOD, EnhancedXAImageIOD, EnhancedXRFImageIOD, IntravascularOpticalCoherenceTomographyImageIOD, LegacyConvertedEnhancedCTImageIOD, LegacyConvertedEnhancedMRImageIOD, LegacyConvertedEnhancedPETImageIOD, MRSpectroscopyIOD, MultiFrameGrayscaleByteSCImageIOD, MultiFrameGrayscaleWordSCImageIOD, MultiFrameTrueColorSCImageIOD, OphthalmicOpticalCoherenceTomographyBScanVolumeAnalysisIOD, OphthalmicTomographyImageIOD, ParametricMapIOD, PerFrameFunctionalGroupsSequence.SimpleHolder, SegmentationIOD, VLWholeSlideMicroscopyImageIOD, XRay3DAngiographicImageIOD, XRay3DCraniofacialImageIOD

Enclosing class:

PerFrameFunctionalGroupsSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Per-frame Functional Groups Sequence" (see PerFrameFunctionalGroupsSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PerFrameFunctionalGroupsSequence.Holder.Builder	builder()
static PerFrameFunctionalGroupsSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPerFrameFunctionalGroupsSequence()
default PerFrameFunctionalGroupsSequence	ensurePerFrameFunctionalGroupsSequence()	Adds a new Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) with initial capacity 1 (see ensurePerFrameFunctionalGroupsSequence(int)) if it does not already exist.
default PerFrameFunctionalGroupsSequence	ensurePerFrameFunctionalGroupsSequence(int initialCapacity)	Adds a new Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) if it does not already exist.
default PerFrameFunctionalGroupsSequence	getPerFrameFunctionalGroupsSequence()
default PerFrameFunctionalGroupsSequence	newPerFrameFunctionalGroupsSequence(int initialCapacity)	Adds a new Per-frame Functional Groups Sequence.
default void	removePerFrameFunctionalGroupsSequence()	Removes the Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence
static PerFrameFunctionalGroupsSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence)

Returns:

a wrapper object implementing the PerFrameFunctionalGroupsSequence.Holder interface.

builder

static PerFrameFunctionalGroupsSequence.Holder.Builder builder()

Returns:

a PerFrameFunctionalGroupsSequence.Holder.Builder to create Per-frame Functional Groups Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PerFrameFunctionalGroupsSequence.Holder.Builder to create Per-frame Functional Groups Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPerFrameFunctionalGroupsSequence

default PerFrameFunctionalGroupsSequence getPerFrameFunctionalGroupsSequence()

Returns:

the Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence)

newPerFrameFunctionalGroupsSequence

default PerFrameFunctionalGroupsSequence newPerFrameFunctionalGroupsSequence(int initialCapacity)

Adds a new Per-frame Functional Groups Sequence. (see PerFrameFunctionalGroupsSequence)

Parameters:

initialCapacity - the initial capacity for the new Per-frame Functional Groups Sequence

Returns:

the newly created PerFrameFunctionalGroupsSequence.

ensurePerFrameFunctionalGroupsSequence

default PerFrameFunctionalGroupsSequence ensurePerFrameFunctionalGroupsSequence(int initialCapacity)

Adds a new Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Per-frame Functional Groups Sequence is created.

Returns:

either the already existing Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) or a new one with capacity initialCapacity.

ensurePerFrameFunctionalGroupsSequence

default PerFrameFunctionalGroupsSequence ensurePerFrameFunctionalGroupsSequence()

Adds a new Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) with initial capacity 1 (see ensurePerFrameFunctionalGroupsSequence(int)) if it does not already exist.

Returns:

either the already existing Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence) or a new one with capacity 1.

containsPerFrameFunctionalGroupsSequence

default boolean containsPerFrameFunctionalGroupsSequence()

Returns:

whether it contains the Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence)

removePerFrameFunctionalGroupsSequence

default void removePerFrameFunctionalGroupsSequence()

Removes the Per-frame Functional Groups Sequence (see PerFrameFunctionalGroupsSequence