Package org.dcm4che.typeddicom.dataelements

Interface DVHSequence.Holder

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

  • Method Details

    • wrap

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

    • builder

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

    • builder

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

    • getDVHSequence

      default DVHSequence getDVHSequence()
      Returns:
      the DVH Sequence (see DVHSequence)

    • newDVHSequence

      default DVHSequence newDVHSequence(int initialCapacity)
      Adds a new DVH Sequence. (see DVHSequence)
      Parameters:
      initialCapacity - the initial capacity for the new DVH Sequence

    • ensureDVHSequence

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

    • ensureDVHSequence

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

    • containsDVHSequence

      default boolean containsDVHSequence()
      Returns:
      Whether it contains the DVH Sequence (see DVHSequence)

    • removeDVHSequence

      default void removeDVHSequence()
      Removes the DVH Sequence (see DVHSequence