Package org.dcm4che.typeddicom.dataelements

Interface TreatmentDeviceIdentificationSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTDeliveryDeviceCommonModule, RTRadiationSetDeliveryInstructionModule

All Known Implementing Classes:

CArmPhotonElectronRadiationIOD, CArmPhotonElectronRadiationRecordIOD, RoboticArmRadiationIOD, RoboticArmRadiationRecordIOD, RTDeliveryDeviceCommonModule.SimpleWrapper, RTRadiationSalvageRecordIOD, RTRadiationSetDeliveryInstructionIOD, RTRadiationSetDeliveryInstructionModule.SimpleWrapper, TomotherapeuticRadiationIOD, TomotherapeuticRadiationRecordIOD

Enclosing class:

TreatmentDeviceIdentificationSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Device Identification Sequence" (see TreatmentDeviceIdentificationSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentDeviceIdentificationSequence.Holder.Builder	builder()
static TreatmentDeviceIdentificationSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentDeviceIdentificationSequence()
default TreatmentDeviceIdentificationSequence	ensureTreatmentDeviceIdentificationSequence()	Adds a new Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) with initial capacity 1 (see ensureTreatmentDeviceIdentificationSequence(int)) if it does not already exist.
default TreatmentDeviceIdentificationSequence	ensureTreatmentDeviceIdentificationSequence(int initialCapacity)	Adds a new Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) if it does not already exist.
default TreatmentDeviceIdentificationSequence	getTreatmentDeviceIdentificationSequence()
default TreatmentDeviceIdentificationSequence	newTreatmentDeviceIdentificationSequence(int initialCapacity)	Adds a new Treatment Device Identification Sequence.
default void	removeTreatmentDeviceIdentificationSequence()	Removes the Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence
static TreatmentDeviceIdentificationSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence)

Returns:

a wrapper object implementing the TreatmentDeviceIdentificationSequence.Holder interface.

builder

static TreatmentDeviceIdentificationSequence.Holder.Builder builder()

Returns:

a TreatmentDeviceIdentificationSequence.Holder.Builder to create Treatment Device Identification Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a TreatmentDeviceIdentificationSequence.Holder.Builder to create Treatment Device Identification Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getTreatmentDeviceIdentificationSequence

default TreatmentDeviceIdentificationSequence getTreatmentDeviceIdentificationSequence()

Returns:

the Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence)

newTreatmentDeviceIdentificationSequence

default TreatmentDeviceIdentificationSequence newTreatmentDeviceIdentificationSequence(int initialCapacity)

Adds a new Treatment Device Identification Sequence. (see TreatmentDeviceIdentificationSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Device Identification Sequence

Returns:

the newly created TreatmentDeviceIdentificationSequence.

ensureTreatmentDeviceIdentificationSequence

default TreatmentDeviceIdentificationSequence ensureTreatmentDeviceIdentificationSequence(int initialCapacity)

Adds a new Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

initialCapacity - the initial capacity (see ArrayList(int)) if a new Treatment Device Identification Sequence is created.

Returns:

either the already existing Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) or a new one with capacity initialCapacity.

ensureTreatmentDeviceIdentificationSequence

default TreatmentDeviceIdentificationSequence ensureTreatmentDeviceIdentificationSequence()

Adds a new Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) with initial capacity 1 (see ensureTreatmentDeviceIdentificationSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence) or a new one with capacity 1.

containsTreatmentDeviceIdentificationSequence

default boolean containsTreatmentDeviceIdentificationSequence()

Returns:

whether it contains the Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence)

removeTreatmentDeviceIdentificationSequence

default void removeTreatmentDeviceIdentificationSequence()

Removes the Treatment Device Identification Sequence (see TreatmentDeviceIdentificationSequence