Package org.dcm4che.typeddicom.dataelements

Interface PatientSetupSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

RTPatientSetupModule

All Known Implementing Classes:

GeneralMachineVerificationSequence.Item, PatientSetupSequence.SimpleHolder, RTBeamsTreatmentRecordIOD, RTBrachyTreatmentRecordIOD, RTIonBeamsTreatmentRecordIOD, RTIonPlanIOD, RTPlanIOD

Enclosing class:

PatientSetupSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Setup Sequence" (see PatientSetupSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientSetupSequence.Holder.Builder	builder()
static PatientSetupSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientSetupSequence()
default PatientSetupSequence	ensurePatientSetupSequence()	Adds a new Patient Setup Sequence (see PatientSetupSequence) with initial capacity 1 (see ensurePatientSetupSequence(int)) if it does not already exist.
default PatientSetupSequence	ensurePatientSetupSequence(int initialCapacity)	Adds a new Patient Setup Sequence (see PatientSetupSequence) if it does not already exist.
default PatientSetupSequence	getPatientSetupSequence()
default PatientSetupSequence	newPatientSetupSequence(int initialCapacity)	Adds a new Patient Setup Sequence.
default void	removePatientSetupSequence()	Removes the Patient Setup Sequence (see PatientSetupSequence
static PatientSetupSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Setup Sequence (see PatientSetupSequence)

Returns:

a wrapper object implementing the PatientSetupSequence.Holder interface.

builder

static PatientSetupSequence.Holder.Builder builder()

Returns:

a PatientSetupSequence.Holder.Builder to create Patient Setup Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

a PatientSetupSequence.Holder.Builder to create Patient Setup Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getPatientSetupSequence

default PatientSetupSequence getPatientSetupSequence()

Returns:

the Patient Setup Sequence (see PatientSetupSequence)

newPatientSetupSequence

default PatientSetupSequence newPatientSetupSequence(int initialCapacity)

Adds a new Patient Setup Sequence. (see PatientSetupSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Setup Sequence

Returns:

the newly created PatientSetupSequence.

ensurePatientSetupSequence

default PatientSetupSequence ensurePatientSetupSequence(int initialCapacity)

Adds a new Patient Setup Sequence (see PatientSetupSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Setup Sequence (see PatientSetupSequence) or a new one with capacity initialCapacity.

ensurePatientSetupSequence

default PatientSetupSequence ensurePatientSetupSequence()

Adds a new Patient Setup Sequence (see PatientSetupSequence) with initial capacity 1 (see ensurePatientSetupSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Setup Sequence (see PatientSetupSequence) or a new one with capacity 1.

containsPatientSetupSequence

default boolean containsPatientSetupSequence()

Returns:

whether it contains the Patient Setup Sequence (see PatientSetupSequence)

removePatientSetupSequence

default void removePatientSetupSequence()

Removes the Patient Setup Sequence (see PatientSetupSequence