Package org.dcm4che.typeddicom.dataelements

Interface TreatmentSummaryCalculatedDoseReferenceSequence.Holder

All Superinterfaces:

AttributesWrapper

All Known Subinterfaces:

RTTreatmentSummaryRecordModule

All Known Implementing Classes:

RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD, RTTreatmentSummaryRecordIOD

Enclosing class:

TreatmentSummaryCalculatedDoseReferenceSequence

public static interface TreatmentSummaryCalculatedDoseReferenceSequence.Holder
extends AttributesWrapper

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

Method Summary

Modifier and Type	Method	Description
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 Details

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.

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

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