Package org.dcm4che.typeddicom.dataelements

Interface PlanningLandmarkPlaneSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

GenericImplantTemplatePlanningLandmarksModule

All Known Implementing Classes:

GenericImplantTemplateIOD, PlanningLandmarkPlaneSequence.SimpleHolder

Enclosing class:

PlanningLandmarkPlaneSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Planning Landmark Plane Sequence" (see PlanningLandmarkPlaneSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PlanningLandmarkPlaneSequence.Holder.Builder	builder()
static PlanningLandmarkPlaneSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPlanningLandmarkPlaneSequence()
default PlanningLandmarkPlaneSequence	ensurePlanningLandmarkPlaneSequence()	Adds a new Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) with initial capacity 1 (see ensurePlanningLandmarkPlaneSequence(int)) if it does not already exist.
default PlanningLandmarkPlaneSequence	ensurePlanningLandmarkPlaneSequence(int initialCapacity)	Adds a new Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) if it does not already exist.
default PlanningLandmarkPlaneSequence	getPlanningLandmarkPlaneSequence()
default PlanningLandmarkPlaneSequence	newPlanningLandmarkPlaneSequence(int initialCapacity)	Adds a new Planning Landmark Plane Sequence.
default void	removePlanningLandmarkPlaneSequence()	Removes the Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence
static PlanningLandmarkPlaneSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence)

Returns:

a wrapper object implementing the PlanningLandmarkPlaneSequence.Holder interface.

builder

static PlanningLandmarkPlaneSequence.Holder.Builder builder()

Returns:

a PlanningLandmarkPlaneSequence.Holder.Builder to create Planning Landmark Plane Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PlanningLandmarkPlaneSequence.Holder.Builder to create Planning Landmark Plane Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPlanningLandmarkPlaneSequence

default PlanningLandmarkPlaneSequence getPlanningLandmarkPlaneSequence()

Returns:

the Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence)

newPlanningLandmarkPlaneSequence

default PlanningLandmarkPlaneSequence newPlanningLandmarkPlaneSequence(int initialCapacity)

Adds a new Planning Landmark Plane Sequence. (see PlanningLandmarkPlaneSequence)

Parameters:

initialCapacity - the initial capacity for the new Planning Landmark Plane Sequence

Returns:

the newly created PlanningLandmarkPlaneSequence.

ensurePlanningLandmarkPlaneSequence

default PlanningLandmarkPlaneSequence ensurePlanningLandmarkPlaneSequence(int initialCapacity)

Adds a new Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Planning Landmark Plane Sequence is created.

Returns:

either the already existing Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) or a new one with capacity initialCapacity.

ensurePlanningLandmarkPlaneSequence

default PlanningLandmarkPlaneSequence ensurePlanningLandmarkPlaneSequence()

Adds a new Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) with initial capacity 1 (see ensurePlanningLandmarkPlaneSequence(int)) if it does not already exist.

Returns:

either the already existing Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence) or a new one with capacity 1.

containsPlanningLandmarkPlaneSequence

default boolean containsPlanningLandmarkPlaneSequence()

Returns:

whether it contains the Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence)

removePlanningLandmarkPlaneSequence

default void removePlanningLandmarkPlaneSequence()

Removes the Planning Landmark Plane Sequence (see PlanningLandmarkPlaneSequence