Agenda
######

.. currentmodule:: pyarts.arts

.. autoclass:: Agenda

  .. rubric:: Overview

  .. list-table::

    * - Method
      - :func:`~pyarts.arts.Agenda.add`
      - Adds a method to the Agenda
    * - Method
      - :func:`~pyarts.arts.Agenda.document`
      - Returns a list of methods
    * - Method
      - :func:`~pyarts.arts.Agenda.execute`
      - Executes the agenda on the provided workspace
    * - Method
      - :func:`~pyarts.arts.Agenda.finalize`
      - Finalize the agenda, making it possible to use it in the workspace
    * - Method
      - :func:`~pyarts.arts.Agenda.readxml`
      - Read variable from file
    * - Method
      - :func:`~pyarts.arts.Agenda.savexml`
      - Saves variable to file
    * - Static Method
      - :func:`~pyarts.arts.Agenda.fromxml`
      - Create variable from file
    * - Attribute
      - :attr:`~pyarts.arts.Agenda.methods`
      - The methods of the agenda
    * - Attribute
      - :attr:`~pyarts.arts.Agenda.name`
      - The name of the agenda
    * - Operator
      - :func:`~pyarts.arts.Agenda.__eq__`
      - Return self==value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__format__`
      - __format__(self, arg: str, /) -> str
    * - Operator
      - :func:`~pyarts.arts.Agenda.__ge__`
      - Return self>=value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__getstate__`
      - Helper for pickle.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__gt__`
      - Return self>value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__hash__`
      - Return hash(self).
    * - Operator
      - :func:`~pyarts.arts.Agenda.__init__`
      - Overloaded function.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__le__`
      - Return self<=value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__lt__`
      - Return self<value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__ne__`
      - Return self!=value.
    * - Operator
      - :func:`~pyarts.arts.Agenda.__repr__`
      - __repr__(self) -> str
    * - Operator
      - :func:`~pyarts.arts.Agenda.__str__`
      - __str__(self) -> str

  .. rubric:: Constructors

  .. automethod:: __init__
     :noindex:

  .. rubric:: Methods

  .. automethod:: Agenda.add
  .. automethod:: Agenda.document
  .. automethod:: Agenda.execute
  .. automethod:: Agenda.finalize
  .. automethod:: Agenda.readxml
  .. automethod:: Agenda.savexml

  .. rubric:: Static Methods

  .. automethod:: Agenda.fromxml

  .. rubric:: Attributes

  .. autoattribute:: Agenda.methods
  .. autoattribute:: Agenda.name

  .. rubric:: Operators

  .. automethod:: Agenda.__eq__
  .. automethod:: Agenda.__format__
  .. automethod:: Agenda.__ge__
  .. automethod:: Agenda.__getstate__
  .. automethod:: Agenda.__gt__
  .. automethod:: Agenda.__hash__
  .. automethod:: Agenda.__init__
  .. automethod:: Agenda.__le__
  .. automethod:: Agenda.__lt__
  .. automethod:: Agenda.__ne__
  .. automethod:: Agenda.__repr__
  .. automethod:: Agenda.__str__