Package org.dcm4che.typeddicom.dataelements

Interface ReferencedRTPlanSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTBeamsDeliveryInstructionModule, RTBrachyApplicationSetupDeliveryInstructionModule, RTDoseModule, RTGeneralMachineVerificationModule, RTGeneralPlanModule, RTGeneralTreatmentRecordModule, RTImageModule

All Known Implementing Classes:

ReferencedRTPlanSequence.SimpleHolder, RTBeamsDeliveryInstructionIOD, RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupDeliveryInstructionIOD, RTBrachyTreatmentRecordIOD, RTConventionalMachineVerificationIOD, RTDoseIOD, RTImageIOD, RTIonBeamsTreatmentRecordIOD, RTIonMachineVerificationIOD, RTIonPlanIOD, RTPlanIOD, RTTreatmentSummaryRecordIOD

Enclosing class:

ReferencedRTPlanSequence

public static interface ReferencedRTPlanSequence.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Referenced RT Plan Sequence" (see ReferencedRTPlanSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ReferencedRTPlanSequence.Holder.Builder	builder()
static ReferencedRTPlanSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsReferencedRTPlanSequence()
default ReferencedRTPlanSequence	ensureReferencedRTPlanSequence()	Adds a new Referenced RT Plan Sequence (see ReferencedRTPlanSequence) with initial capacity 1 (see ensureReferencedRTPlanSequence(int)) if it does not already exist.
default ReferencedRTPlanSequence	ensureReferencedRTPlanSequence(int initialCapacity)	Adds a new Referenced RT Plan Sequence (see ReferencedRTPlanSequence) if it does not already exist.
default ReferencedRTPlanSequence	getReferencedRTPlanSequence()
default ReferencedRTPlanSequence	newReferencedRTPlanSequence(int initialCapacity)	Adds a new Referenced RT Plan Sequence.
default void	removeReferencedRTPlanSequence()	Removes the Referenced RT Plan Sequence (see ReferencedRTPlanSequence
static ReferencedRTPlanSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Referenced RT Plan Sequence (see ReferencedRTPlanSequence)

Returns:

A wrapper object implementing the ReferencedRTPlanSequence.Holder interface.

builder

static ReferencedRTPlanSequence.Holder.Builder builder()

Returns:

a ReferencedRTPlanSequence.Holder.Builder to create Referenced RT Plan Sequence Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the ReferencedRTPlanSequence.Holder.Builder.

Returns:

a ReferencedRTPlanSequence.Holder.Builder to create Referenced RT Plan Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getReferencedRTPlanSequence

default ReferencedRTPlanSequence getReferencedRTPlanSequence()

Returns:

the Referenced RT Plan Sequence (see ReferencedRTPlanSequence)

newReferencedRTPlanSequence

default ReferencedRTPlanSequence newReferencedRTPlanSequence(int initialCapacity)

Adds a new Referenced RT Plan Sequence. (see ReferencedRTPlanSequence)

Parameters:

initialCapacity - the initial capacity for the new Referenced RT Plan Sequence

ensureReferencedRTPlanSequence

default ReferencedRTPlanSequence ensureReferencedRTPlanSequence(int initialCapacity)

Adds a new Referenced RT Plan Sequence (see ReferencedRTPlanSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - The initial capacity (see ArrayList(int)) if a new Referenced RT Plan Sequence is created.

Returns:

Either the already existing Referenced RT Plan Sequence (see ReferencedRTPlanSequence) or a new one with capacity initialCapacity.

ensureReferencedRTPlanSequence

default ReferencedRTPlanSequence ensureReferencedRTPlanSequence()

Adds a new Referenced RT Plan Sequence (see ReferencedRTPlanSequence) with initial capacity 1 (see ensureReferencedRTPlanSequence(int)) if it does not already exist.

Returns:

Either the already existing Referenced RT Plan Sequence (see ReferencedRTPlanSequence) or a new one with capacity 1.

containsReferencedRTPlanSequence

default boolean containsReferencedRTPlanSequence()

Returns:

Whether it contains the Referenced RT Plan Sequence (see ReferencedRTPlanSequence)

removeReferencedRTPlanSequence

default void removeReferencedRTPlanSequence()

Removes the Referenced RT Plan Sequence (see ReferencedRTPlanSequence