Package org.dcm4che.typeddicom.dataelements

Interface SequenceOfUltrasoundRegions.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

USRegionCalibrationModule

All Known Implementing Classes:

UltrasoundImageIOD, UltrasoundMultiFrameImageIOD, USRegionCalibrationModule.SimpleWrapper

Enclosing class:

SequenceOfUltrasoundRegions

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

A class implementing this interface can hold attributes which contain the DICOM tag "Sequence of Ultrasound Regions" (see SequenceOfUltrasoundRegions)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SequenceOfUltrasoundRegions.Holder.Builder	builder()
static SequenceOfUltrasoundRegions.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsSequenceOfUltrasoundRegions()
default SequenceOfUltrasoundRegions	ensureSequenceOfUltrasoundRegions()	Adds a new Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) with initial capacity 1 (see ensureSequenceOfUltrasoundRegions(int)) if it does not already exist.
default SequenceOfUltrasoundRegions	ensureSequenceOfUltrasoundRegions(int initialCapacity)	Adds a new Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) if it does not already exist.
default SequenceOfUltrasoundRegions	getSequenceOfUltrasoundRegions()
default SequenceOfUltrasoundRegions	newSequenceOfUltrasoundRegions(int initialCapacity)	Adds a new Sequence of Ultrasound Regions.
default void	removeSequenceOfUltrasoundRegions()	Removes the Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions
static SequenceOfUltrasoundRegions.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions)

Returns:

a wrapper object implementing the SequenceOfUltrasoundRegions.Holder interface.

builder

static SequenceOfUltrasoundRegions.Holder.Builder builder()

Returns:

a SequenceOfUltrasoundRegions.Holder.Builder to create Sequence of Ultrasound Regions Items with a fluent API.

builder

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

Parameters:

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

Returns:

a SequenceOfUltrasoundRegions.Holder.Builder to create Sequence of Ultrasound Regions Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getSequenceOfUltrasoundRegions

default SequenceOfUltrasoundRegions getSequenceOfUltrasoundRegions()

Returns:

the Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions)

newSequenceOfUltrasoundRegions

default SequenceOfUltrasoundRegions newSequenceOfUltrasoundRegions(int initialCapacity)

Adds a new Sequence of Ultrasound Regions. (see SequenceOfUltrasoundRegions)

Parameters:

initialCapacity - the initial capacity for the new Sequence of Ultrasound Regions

Returns:

the newly created SequenceOfUltrasoundRegions.

ensureSequenceOfUltrasoundRegions

default SequenceOfUltrasoundRegions ensureSequenceOfUltrasoundRegions(int initialCapacity)

Adds a new Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Sequence of Ultrasound Regions is created.

Returns:

either the already existing Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) or a new one with capacity initialCapacity.

ensureSequenceOfUltrasoundRegions

default SequenceOfUltrasoundRegions ensureSequenceOfUltrasoundRegions()

Adds a new Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) with initial capacity 1 (see ensureSequenceOfUltrasoundRegions(int)) if it does not already exist.

Returns:

either the already existing Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions) or a new one with capacity 1.

containsSequenceOfUltrasoundRegions

default boolean containsSequenceOfUltrasoundRegions()

Returns:

whether it contains the Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions)

removeSequenceOfUltrasoundRegions

default void removeSequenceOfUltrasoundRegions()

Removes the Sequence of Ultrasound Regions (see SequenceOfUltrasoundRegions