Source code for foxes.algorithms.sequential.models.plugin

[docs]
class SequentialPlugin:
    """
    Base class for plugins that are
    updated with each sequential iteration

    Parameters
    ----------
    algo: foxes.algorithms.sequential.Sequential
        The sequential algorithm

    :group: algorithms.sequential.models

    """


[docs]
    def __init__(self):
        """
        Constructor.
        """
        self.algo = None



[docs]
    def initialize(self, algo):
        """
        Initialize data based on the intial iterator

        Parameters
        ----------
        algo: foxes.algorithms.sequential.Sequential
            The current sequential algorithm

        """
        self.algo = algo



[docs]
    def update(self, algo, fres, pres=None):
        """
        Updates data based on current iteration

        Parameters
        ----------
        algo: foxes.algorithms.sequential.Sequential
            The latest sequential algorithm
        fres: xarray.Dataset
            The latest farm results
        pres: xarray.Dataset, optional
            The latest point results

        """
        self.algo = algo



[docs]
    def finalize(self, algo):
        """
        Finalize data based on the final iterator

        Parameters
        ----------
        algo: foxes.algorithms.sequential.Sequential
            The final sequential algorithm

        """
        self.algo = algo