Package org.dcm4che.typeddicom.dataelements

Interface BeamSequence.Holder

All Superinterfaces:
AttributesWrapper
All Known Subinterfaces:
RTBeamsModule
All Known Implementing Classes:
BeamSequence.SimpleHolder, RTPlanIOD
Enclosing class:
BeamSequence
public static interface BeamSequence.Holder extends AttributesWrapper
A class implementing this interface can hold attributes which contain the DICOM tag "Beam Sequence" (see BeamSequence)

  • Method Details

    • wrap

      static BeamSequence.Holder wrap(org.dcm4che3.data.Attributes attributes)
      Parameters:
      attributes - An attributes object containing the Beam Sequence (see BeamSequence)
      Returns:
      A wrapper object implementing the BeamSequence.Holder interface.

    • builder

      static BeamSequence.Holder.Builder builder()
      Returns:
      a BeamSequence.Holder.Builder to create Beam Sequence Items with a fluent API.

    • builder

      static BeamSequence.Holder.Builder builder(org.dcm4che3.data.Attributes attributes)
      Parameters:
      attributes - The Attributes to be wrapped by the BeamSequence.Holder.Builder.
      Returns:
      a BeamSequence.Holder.Builder to create Beam Sequence Items with a fluent API. Instead of creating new Attributes it wraps the provided Attributes.

    • getBeamSequence

      default BeamSequence getBeamSequence()
      Returns:
      the Beam Sequence (see BeamSequence)

    • newBeamSequence

      default BeamSequence newBeamSequence(int initialCapacity)
      Adds a new Beam Sequence. (see BeamSequence)
      Parameters:
      initialCapacity - the initial capacity for the new Beam Sequence

    • ensureBeamSequence

      default BeamSequence ensureBeamSequence(int initialCapacity)
      Adds a new Beam Sequence (see BeamSequence) if it does not already exist. (see Attributes.ensureSequence(int, int)
      Parameters:
      initialCapacity - The initial capacity (see ArrayList(int)) if a new Beam Sequence is created.
      Returns:
      Either the already existing Beam Sequence (see BeamSequence) or a new one with capacity initialCapacity.

    • ensureBeamSequence

      default BeamSequence ensureBeamSequence()
      Adds a new Beam Sequence (see BeamSequence) with initial capacity 1 (see ensureBeamSequence(int)) if it does not already exist.
      Returns:
      Either the already existing Beam Sequence (see BeamSequence) or a new one with capacity 1.

    • containsBeamSequence

      default boolean containsBeamSequence()
      Returns:
      Whether it contains the Beam Sequence (see BeamSequence)

    • removeBeamSequence

      default void removeBeamSequence()
      Removes the Beam Sequence (see BeamSequence