scml.std.sysagents
==================

.. py:module:: scml.std.sysagents


Classes
-------

.. autoapisummary::

   scml.std.sysagents._StdSystemAgent
   scml.std.sysagents.DefaultStdAdapter


Module Contents
---------------

.. py:class:: _StdSystemAgent(*args, role, **kwargs)

   Bases: :py:obj:`DefaultOneShotAdapter`


   Implements an agent for handling system operations


   .. py:attribute:: id

      The unique ID of this entity


   .. py:attribute:: name

      A convenient name of the entity (intended primarily for printing/logging/debugging).


   .. py:attribute:: profile
      :value: None



   .. py:property:: type_name

      Returns a short name of the type of this entity


   .. py:property:: short_type_name

      Returns a short name of the type of this entity


   .. py:method:: respond_to_negotiation_request(initiator: str, issues: list[negmas.Issue], annotation: dict[str, Any], mechanism: negmas.NegotiatorMechanismInterface) -> Optional[negmas.Negotiator]


   .. py:method:: before_step()


   .. py:method:: step()

      Override this method to modify stepping logic



   .. py:method:: init()

      Override this method to modify initialization logic



   .. py:method:: on_negotiation_failure(partners: list[str], annotation: dict[str, Any], mechanism: negmas.NegotiatorMechanismInterface, state: negmas.MechanismState) -> None

      Called whenever a negotiation ends without agreement



   .. py:method:: on_negotiation_success(contract: negmas.Contract, mechanism: negmas.NegotiatorMechanismInterface) -> None

      Called whenever a negotiation ends with agreement



   .. py:method:: sign_all_contracts(contracts: list[negmas.Contract]) -> list[Optional[str]]

      Signs all contracts



.. py:class:: DefaultStdAdapter(*args, **kwargs)

   Bases: :py:obj:`scml.oneshot.sysagents.DefaultOneShotAdapter`


   The base class of all agents running in Std based on StdAgent.

   Remarks:

       - It inherits from `Adapter` allowing it to just pass any calls not
         defined explicity in it to the internal `_obj` object representing
         the StdAgent.