Source code for utils.base_agents

import numpy as np



class BaseLoadShiftingAgent:
    """
    Base class for load shifting agents.

    Args:
        parameters (dict) :  Dictionary containing the agent parameters.
    """
    def __init__(self, parameters=None):
        """
        Args:
            parameters (dict) :  Dictionary containing the agent parameters.
        """
        self.parameters = parameters
        self.do_nothing_action_value = 1
        # Add a warning message to inform the user to check if the do nothing action is the '1' action.
        print(f"Warning: Please check if the do nothing action for Load Shifting Agent is the '{self.do_nothing_action_value}' action.")
        


    def do_nothing_action(self):
        """
        Return the do nothing action.
        
        Returns:
            action (int): The action (do nothing) to be taken.
        """
        return self.do_nothing_action_value


    


class BaseHVACAgent:
    """
    Base class for HVAC agents.

    Parameters
    ----------
    parameters : dict
        Dictionary containing the agent parameters.
    """
    def __init__(self, parameters=None):
        """

        Parameters
        ----------
        parameters : dict
            Dictionary containing the agent parameters.
        """
        self.parameters = parameters
        self.do_nothing_action_value = np.int64(1)
        # Add a warning message to inform the user to check if the do nothing action is the '1' action.
        print(f"Warning: Please check if the do nothing action for HVAC is the '{self.do_nothing_action_value}' action.")
        


    def do_nothing_action(self):
        """
        Return the do nothing action.
        
        Returns:
            action (int): The action (do nothing) to be taken.
        """
        return self.do_nothing_action_value





class BaseBatteryAgent:
    """
    Base class for battery agents.

    Args:
        parameters (dict) :  Dictionary containing the agent parameters.
    """
    def __init__(self, parameters=None):
        """
        Args:
            parameters (dict) :  Dictionary containing the agent parameters.
        """
        self.parameters = parameters
        self.do_nothing_action_value = 2
        # Add a warning message to inform the user to check if the do nothing action is the '1' action.
        print(f"Warning: Please check if the do nothing action for Battery is the '{self.do_nothing_action_value}' action.")
        


    def do_nothing_action(self):
        """
        Return the do nothing action.
        
        Returns:
            action (int): The action (do nothing) to be taken.
        """
        return self.do_nothing_action_value

    


    def act(self, *args, **kwargs):
        """
        Return the do nothing action regardless of the input parameters.

        Args:
            *args: Arbitrary positional arguments.
            **kwargs: Arbitrary keyword arguments.

        Returns:
            action (int): The action (do nothing) to be taken.
        """
        return self.do_nothing_action()