Package org.dcm4che.typeddicom.dataelements

Interface RTTreatmentTerminationReasonCodeSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTRadiationRecordCommonModule

All Known Implementing Classes:

CArmPhotonElectronRadiationRecordIOD, RoboticArmRadiationRecordIOD, RTRadiationRecordCommonModule.SimpleWrapper, RTRadiationSalvageRecordIOD, TomotherapeuticRadiationRecordIOD

Enclosing class:

RTTreatmentTerminationReasonCodeSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "RT Treatment Termination Reason Code Sequence" (see RTTreatmentTerminationReasonCodeSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RTTreatmentTerminationReasonCodeSequence.Holder.Builder	builder()
static RTTreatmentTerminationReasonCodeSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsRTTreatmentTerminationReasonCodeSequence()
default RTTreatmentTerminationReasonCodeSequence	ensureRTTreatmentTerminationReasonCodeSequence()	Adds a new RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) with initial capacity 1 (see ensureRTTreatmentTerminationReasonCodeSequence(int)) if it does not already exist.
default RTTreatmentTerminationReasonCodeSequence	ensureRTTreatmentTerminationReasonCodeSequence(int initialCapacity)	Adds a new RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) if it does not already exist.
default RTTreatmentTerminationReasonCodeSequence	getRTTreatmentTerminationReasonCodeSequence()
default RTTreatmentTerminationReasonCodeSequence	newRTTreatmentTerminationReasonCodeSequence(int initialCapacity)	Adds a new RT Treatment Termination Reason Code Sequence.
default void	removeRTTreatmentTerminationReasonCodeSequence()	Removes the RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence
static RTTreatmentTerminationReasonCodeSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence)

Returns:

a wrapper object implementing the RTTreatmentTerminationReasonCodeSequence.Holder interface.

builder

static RTTreatmentTerminationReasonCodeSequence.Holder.Builder builder()

Returns:

a RTTreatmentTerminationReasonCodeSequence.Holder.Builder to create RT Treatment Termination Reason Code Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a RTTreatmentTerminationReasonCodeSequence.Holder.Builder to create RT Treatment Termination Reason Code Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getRTTreatmentTerminationReasonCodeSequence

default RTTreatmentTerminationReasonCodeSequence getRTTreatmentTerminationReasonCodeSequence()

Returns:

the RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence)

newRTTreatmentTerminationReasonCodeSequence

default RTTreatmentTerminationReasonCodeSequence newRTTreatmentTerminationReasonCodeSequence(int initialCapacity)

Adds a new RT Treatment Termination Reason Code Sequence. (see RTTreatmentTerminationReasonCodeSequence)

Parameters:

initialCapacity - the initial capacity for the new RT Treatment Termination Reason Code Sequence

Returns:

the newly created RTTreatmentTerminationReasonCodeSequence.

ensureRTTreatmentTerminationReasonCodeSequence

default RTTreatmentTerminationReasonCodeSequence ensureRTTreatmentTerminationReasonCodeSequence(int initialCapacity)

Adds a new RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new RT Treatment Termination Reason Code Sequence is created.

Returns:

either the already existing RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) or a new one with capacity initialCapacity.

ensureRTTreatmentTerminationReasonCodeSequence

default RTTreatmentTerminationReasonCodeSequence ensureRTTreatmentTerminationReasonCodeSequence()

Adds a new RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) with initial capacity 1 (see ensureRTTreatmentTerminationReasonCodeSequence(int)) if it does not already exist.

Returns:

either the already existing RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence) or a new one with capacity 1.

containsRTTreatmentTerminationReasonCodeSequence

default boolean containsRTTreatmentTerminationReasonCodeSequence()

Returns:

whether it contains the RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence)

removeRTTreatmentTerminationReasonCodeSequence

default void removeRTTreatmentTerminationReasonCodeSequence()

Removes the RT Treatment Termination Reason Code Sequence (see RTTreatmentTerminationReasonCodeSequence