Package org.dcm4che.typeddicom.dataelements

Interface BeamName.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

BeamName.SimpleHolder, BeamSequence.Item, GeneralMachineVerificationSequence.Item, IonBeamSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

BeamName

public static interface BeamName.Holder
extends AttributesWrapper

A class implementing this interface can hold attributes which contain the DICOM tag "Beam Name" (see BeamName)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamName.Holder.Builder	builder()
static BeamName.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamName()
default BeamName	getBeamName()
default void	removeBeamName()	Removes the Beam Name (see BeamName
static BeamName.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Beam Name (see BeamName)

Returns:

A wrapper object implementing the BeamName.Holder interface.

builder

static BeamName.Holder.Builder builder()

Returns:

a BeamName.Holder.Builder to create Beam Name Items with a fluent API.

builder

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

Parameters:

attributes - The Attributes to be wrapped by the BeamName.Holder.Builder.

Returns:

a BeamName.Holder.Builder to create Beam Name Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

getBeamName

default BeamName getBeamName()

Returns:

the Beam Name (see BeamName)

containsBeamName

default boolean containsBeamName()

Returns:

Whether it contains the Beam Name (see BeamName)

removeBeamName

default void removeBeamName()

Removes the Beam Name (see BeamName