Package org.dcm4che.typeddicom.dataelements

Interface BeamDescription.Holder

All Superinterfaces:

AttributesWrapper

All Known Implementing Classes:

BeamDescription.SimpleHolder, BeamSequence.Item, IonBeamSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

BeamDescription

public static interface BeamDescription.Holder
extends AttributesWrapper

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static BeamDescription.Holder.Builder	builder()
static BeamDescription.Holder.Builder	builder(org.dcm4che3.data.Attributes attributes)
default boolean	containsBeamDescription()
default BeamDescription	getBeamDescription()
default void	removeBeamDescription()	Removes the Beam Description (see BeamDescription
static BeamDescription.Holder	wrap(org.dcm4che3.data.Attributes attributes)

Methods inherited from interface org.dcm4che.typeddicom.AttributesWrapper

copy, getAttributes, isEmpty

Method Details

wrap

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

Parameters:

attributes - An attributes object containing the Beam Description (see BeamDescription)

Returns:

A wrapper object implementing the BeamDescription.Holder interface.

builder

static BeamDescription.Holder.Builder builder()

Returns:

a BeamDescription.Holder.Builder to create Beam Description Items with a fluent API.

builder

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

Parameters:

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

Returns:

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

getBeamDescription

default BeamDescription getBeamDescription()

Returns:

the Beam Description (see BeamDescription)

containsBeamDescription

default boolean containsBeamDescription()

Returns:

Whether it contains the Beam Description (see BeamDescription)

removeBeamDescription

default void removeBeamDescription()

Removes the Beam Description (see BeamDescription