BeamDescription.Holder (dcm4che-typeddicom-lib-std 0.5.3 API)

All Superinterfaces:

org.dcm4che.typeddicom.AttributesWrapper

All Known Implementing Classes:

BeamSequence.Item, IonBeamSequence.Item, TreatmentSessionBeamSequence.Item, TreatmentSessionIonBeamSequence.Item

Enclosing class:

BeamDescription
```
public static interface BeamDescription.Holder
extends org.dcm4che.typeddicom.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

All Methods Static Methods Instance Methods Default Methods
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 Detail
  - 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