BeamDescription.Holder (dcm4che-typeddicom-lib API)

All Superinterfaces:: AttributesWrapper

All Known Implementing Classes:: 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)

Method Summary

Modifier and Type

Method

Description

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.
- 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