scml.oneshot.helper
===================

.. py:module:: scml.oneshot.helper


Classes
-------

.. autoapisummary::

   scml.oneshot.helper.AWIHelper


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

.. py:class:: AWIHelper(owner: scml.oneshot.adapter.OneShotSCML2020Adapter)

   The Agent SCML2020World Interface for SCML2020 world allowing a single process per agent


   .. py:attribute:: _owner


   .. py:attribute:: _world


   .. py:method:: request_negotiations(is_buy: bool, product: int, quantity: int | tuple[int, int], unit_price: int | tuple[int, int], time: int | tuple[int, int], controller: negmas.sao.SAOController | None = None, negotiators: list[negmas.sao.SAONegotiator] | None = None, partners: list[str] | None = None, extra: dict[str, Any] | None = None, copy_partner_id=True) -> bool


   .. py:method:: request_negotiation(is_buy: bool, product: int, quantity: int | tuple[int, int], unit_price: int | tuple[int, int], time: int | tuple[int, int], partner: str, negotiator: negmas.sao.SAONegotiator, extra: dict[str, Any] | None = None) -> bool


   .. py:method:: schedule_production(process: int, repeats: int, step: int | tuple[int, int] = ANY_STEP, line: int = ANY_LINE, override: bool = True, method: str = 'latest', partial_ok: bool = False) -> tuple[numpy.ndarray, numpy.ndarray]


   .. py:method:: order_production(process: int, steps: numpy.ndarray, lines: numpy.ndarray) -> None


   .. py:method:: available_for_production(repeats: int, step: int | tuple[int, int] = ANY_STEP, line: int = ANY_LINE, override: bool = True, method: str = 'latest') -> tuple[numpy.ndarray, numpy.ndarray]


   .. py:method:: set_commands(commands: numpy.ndarray, step: int = -1) -> None


   .. py:method:: cancel_production(step: int, line: int) -> bool


   .. py:property:: trading_prices
      :type: numpy.ndarray | None


      Returns the current trading prices of all products


   .. py:property:: current_balance
      :type: float



   .. py:property:: exogenous_contract_summary


   .. py:method:: __getattr__(attr)


   .. py:property:: inputs
      :type: numpy.ndarray


      Returns the number of inputs to every production process


   .. py:property:: outputs
      :type: numpy.ndarray


      Returns the number of outputs to every production process


   .. py:property:: my_input_products
      :type: numpy.ndarray


      Returns a list of products that are inputs to at least one process the agent can run


   .. py:property:: my_output_products
      :type: numpy.ndarray


      Returns a list of products that are outputs to at least one process the agent can run


   .. py:method:: is_system(aid: str) -> bool

      Checks whether an agent is a system agent or not

      :param aid: Agent ID



   .. py:property:: state
      :type: scml.scml2020.common.FactoryState


      Receives the factory state


   .. py:property:: profile
      :type: scml.scml2020.common.FactoryProfile


      Gets the profile (static private information) associated with the agent


   .. py:property:: allow_zero_quantity
      :type: bool


      Does negotiations allow zero quantity?