Package org.dcm4che.typeddicom.dataelements

Interface TreatmentMachineSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTBrachyApplicationSetupsModule, RTTreatmentMachineRecordModule

All Known Implementing Classes:

RTBeamsTreatmentRecordIOD, RTBrachyApplicationSetupsModule.SimpleWrapper, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD, RTPlanIOD, RTTreatmentMachineRecordModule.SimpleWrapper

Enclosing class:

TreatmentMachineSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Treatment Machine Sequence" (see TreatmentMachineSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static TreatmentMachineSequence.Holder.Builder	builder()
static TreatmentMachineSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsTreatmentMachineSequence()
default TreatmentMachineSequence	ensureTreatmentMachineSequence()	Adds a new Treatment Machine Sequence (see TreatmentMachineSequence) with initial capacity 1 (see ensureTreatmentMachineSequence(int)) if it does not already exist.
default TreatmentMachineSequence	ensureTreatmentMachineSequence(int initialCapacity)	Adds a new Treatment Machine Sequence (see TreatmentMachineSequence) if it does not already exist.
default TreatmentMachineSequence	getTreatmentMachineSequence()
default TreatmentMachineSequence	newTreatmentMachineSequence(int initialCapacity)	Adds a new Treatment Machine Sequence.
default void	removeTreatmentMachineSequence()	Removes the Treatment Machine Sequence (see TreatmentMachineSequence
static TreatmentMachineSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, getKnownAttributeTags, getUnknownAttributeTags, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Treatment Machine Sequence (see TreatmentMachineSequence)

Returns:

a wrapper object implementing the TreatmentMachineSequence.Holder interface.

builder

static TreatmentMachineSequence.Holder.Builder builder()

Returns:

a TreatmentMachineSequence.Holder.Builder to create Treatment Machine Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getTreatmentMachineSequence

default TreatmentMachineSequence getTreatmentMachineSequence()

Returns:

the Treatment Machine Sequence (see TreatmentMachineSequence)

newTreatmentMachineSequence

default TreatmentMachineSequence newTreatmentMachineSequence(int initialCapacity)

Adds a new Treatment Machine Sequence. (see TreatmentMachineSequence)

Parameters:

initialCapacity - the initial capacity for the new Treatment Machine Sequence

Returns:

the newly created TreatmentMachineSequence.

ensureTreatmentMachineSequence

default TreatmentMachineSequence ensureTreatmentMachineSequence(int initialCapacity)

Adds a new Treatment Machine Sequence (see TreatmentMachineSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Treatment Machine Sequence (see TreatmentMachineSequence) or a new one with capacity initialCapacity.

ensureTreatmentMachineSequence

default TreatmentMachineSequence ensureTreatmentMachineSequence()

Adds a new Treatment Machine Sequence (see TreatmentMachineSequence) with initial capacity 1 (see ensureTreatmentMachineSequence(int)) if it does not already exist.

Returns:

either the already existing Treatment Machine Sequence (see TreatmentMachineSequence) or a new one with capacity 1.

containsTreatmentMachineSequence

default boolean containsTreatmentMachineSequence()

Returns:

whether it contains the Treatment Machine Sequence (see TreatmentMachineSequence)

removeTreatmentMachineSequence

default void removeTreatmentMachineSequence()

Removes the Treatment Machine Sequence (see TreatmentMachineSequence