Package org.dcm4che.typeddicom.dataelements

Interface PatientPositioningInstructionSequence.Holder

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Subinterfaces:

PatientPositioningModule

All Known Implementing Classes:

CTDefinedProcedureProtocolIOD, CTPerformedProcedureProtocolIOD, PatientPositioningModule.SimpleWrapper, XADefinedProcedureProtocolIOD, XAPerformedProcedureProtocolIOD

Enclosing class:

PatientPositioningInstructionSequence

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

A class implementing this interface can hold attributes which contain the DICOM tag "Patient Positioning Instruction Sequence" (see PatientPositioningInstructionSequence)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PatientPositioningInstructionSequence.Holder.Builder	builder()
static PatientPositioningInstructionSequence.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsPatientPositioningInstructionSequence()
default PatientPositioningInstructionSequence	ensurePatientPositioningInstructionSequence()	Adds a new Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) with initial capacity 1 (see ensurePatientPositioningInstructionSequence(int)) if it does not already exist.
default PatientPositioningInstructionSequence	ensurePatientPositioningInstructionSequence(int initialCapacity)	Adds a new Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) if it does not already exist.
default PatientPositioningInstructionSequence	getPatientPositioningInstructionSequence()
default PatientPositioningInstructionSequence	newPatientPositioningInstructionSequence(int initialCapacity)	Adds a new Patient Positioning Instruction Sequence.
default void	removePatientPositioningInstructionSequence()	Removes the Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence
static PatientPositioningInstructionSequence.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Detail

wrap

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

Parameters:

attributes - an attributes object containing the Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence)

Returns:

a wrapper object implementing the PatientPositioningInstructionSequence.Holder interface.

builder

static PatientPositioningInstructionSequence.Holder.Builder builder()

Returns:

a PatientPositioningInstructionSequence.Holder.Builder to create Patient Positioning Instruction Sequence Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getPatientPositioningInstructionSequence

default PatientPositioningInstructionSequence getPatientPositioningInstructionSequence()

Returns:

the Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence)

newPatientPositioningInstructionSequence

default PatientPositioningInstructionSequence newPatientPositioningInstructionSequence(int initialCapacity)

Adds a new Patient Positioning Instruction Sequence. (see PatientPositioningInstructionSequence)

Parameters:

initialCapacity - the initial capacity for the new Patient Positioning Instruction Sequence

Returns:

the newly created PatientPositioningInstructionSequence.

ensurePatientPositioningInstructionSequence

default PatientPositioningInstructionSequence ensurePatientPositioningInstructionSequence(int initialCapacity)

Adds a new Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)

Parameters:

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

Returns:

either the already existing Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) or a new one with capacity initialCapacity.

ensurePatientPositioningInstructionSequence

default PatientPositioningInstructionSequence ensurePatientPositioningInstructionSequence()

Adds a new Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) with initial capacity 1 (see ensurePatientPositioningInstructionSequence(int)) if it does not already exist.

Returns:

either the already existing Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence) or a new one with capacity 1.

containsPatientPositioningInstructionSequence

default boolean containsPatientPositioningInstructionSequence()

Returns:

whether it contains the Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence)

removePatientPositioningInstructionSequence

default void removePatientPositioningInstructionSequence()

Removes the Patient Positioning Instruction Sequence (see PatientPositioningInstructionSequence