Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSummaryCalculatedDoseReferenceSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTTreatmentSummaryRecordModule

All Known Implementing Classes:

RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD, RTTreatmentSummaryRecordIOD, TreatmentSummaryCalculatedDoseReferenceSequence.SimpleHolder

Enclosing class:

TreatmentSummaryCalculatedDoseReferenceSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Summary Calculated Dose Reference Sequence" (see TreatmentSummaryCalculatedDoseReferenceSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentSummaryCalculatedDoseReferenceSequence.Holder.Builder	builder()
static TreatmentSummaryCalculatedDoseReferenceSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentSummaryCalculatedDoseReferenceSequence()
default TreatmentSummaryCalculatedDoseReferenceSequence	ensureTreatmentSummaryCalculatedDoseReferenceSequence()	Adds a new Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) with initial capacity 1 (see ensureTreatmentSummaryCalculatedDoseReferenceSequence(int)) if it does not already exist.
default TreatmentSummaryCalculatedDoseReferenceSequence	ensureTreatmentSummaryCalculatedDoseReferenceSequence(int initialCapacity)	Adds a new Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) if it does not already exist.
default TreatmentSummaryCalculatedDoseReferenceSequence	getTreatmentSummaryCalculatedDoseReferenceSequence()
default TreatmentSummaryCalculatedDoseReferenceSequence	newTreatmentSummaryCalculatedDoseReferenceSequence(int initialCapacity)	Adds a new Treatment Summary Calculated Dose Reference Sequence.
default void	removeTreatmentSummaryCalculatedDoseReferenceSequence()	Removes the Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence
static TreatmentSummaryCalculatedDoseReferenceSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence)

Returns:

a wrapper object implementing the TreatmentSummaryCalculatedDoseReferenceSequence.Holder interface.

builder

static TreatmentSummaryCalculatedDoseReferenceSequence.Holder.Builder builder()

Returns:

a TreatmentSummaryCalculatedDoseReferenceSequence.Holder.Builder to create Treatment Summary Calculated Dose Reference Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentSummaryCalculatedDoseReferenceSequence.Holder.Builder to create Treatment Summary Calculated Dose Reference Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentSummaryCalculatedDoseReferenceSequence

default TreatmentSummaryCalculatedDoseReferenceSequence getTreatmentSummaryCalculatedDoseReferenceSequence()

Returns:

the Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence)

newTreatmentSummaryCalculatedDoseReferenceSequence

default TreatmentSummaryCalculatedDoseReferenceSequence newTreatmentSummaryCalculatedDoseReferenceSequence(int initialCapacity)

Adds a new Treatment Summary Calculated Dose Reference Sequence. (see TreatmentSummaryCalculatedDoseReferenceSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Summary Calculated Dose Reference Sequence

Returns:

the newly created TreatmentSummaryCalculatedDoseReferenceSequence.

ensureTreatmentSummaryCalculatedDoseReferenceSequence

default TreatmentSummaryCalculatedDoseReferenceSequence ensureTreatmentSummaryCalculatedDoseReferenceSequence(int initialCapacity)

Adds a new Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Summary Calculated Dose Reference Sequence is created.

Returns:

either the already existing Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) or a new one with capacity initialCapacity.

ensureTreatmentSummaryCalculatedDoseReferenceSequence

default TreatmentSummaryCalculatedDoseReferenceSequence ensureTreatmentSummaryCalculatedDoseReferenceSequence()

Adds a new Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) with initial capacity 1 (see ensureTreatmentSummaryCalculatedDoseReferenceSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence) or a new one with capacity 1.

containsTreatmentSummaryCalculatedDoseReferenceSequence

default boolean containsTreatmentSummaryCalculatedDoseReferenceSequence()

Returns:

whether it contains the Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence)

removeTreatmentSummaryCalculatedDoseReferenceSequence

default void removeTreatmentSummaryCalculatedDoseReferenceSequence()

Removes the Treatment Summary Calculated Dose Reference Sequence (see TreatmentSummaryCalculatedDoseReferenceSequence