World
=====

.. currentmodule:: negmas.situated

.. autoclass:: World
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~World.agreement_fraction
      ~World.agreement_rate
      ~World.breach_fraction
      ~World.breach_level
      ~World.breach_rate
      ~World.business_size
      ~World.cancellation_fraction
      ~World.cancellation_rate
      ~World.cancelled_contracts
      ~World.contract_dropping_fraction
      ~World.contract_err_fraction
      ~World.contract_execution_fraction
      ~World.contract_nullification_fraction
      ~World.current_step
      ~World.erred_contracts
      ~World.executed_contracts
      ~World.id
      ~World.log_folder
      ~World.n_agent_exceptions
      ~World.n_contract_exceptions
      ~World.n_mechanism_exceptions
      ~World.n_negotiation_rounds_failed
      ~World.n_negotiation_rounds_successful
      ~World.n_negotiator_exceptions
      ~World.n_simulation_exceptions
      ~World.n_total_agent_exceptions
      ~World.n_total_simulation_exceptions
      ~World.name
      ~World.nullified_contracts
      ~World.relative_time
      ~World.remaining_steps
      ~World.remaining_time
      ~World.resolved_breaches
      ~World.saved_breaches
      ~World.saved_contracts
      ~World.saved_negotiations
      ~World.short_type_name
      ~World.signed_contracts
      ~World.stat_names
      ~World.stats
      ~World.time
      ~World.total_time
      ~World.type_name
      ~World.unresolved_breaches
      ~World.uuid

   .. rubric:: Methods Summary

   .. autosummary::

      ~World.action_info_cols
      ~World.agreement_info_cols
      ~World.announce
      ~World.append_stats
      ~World.breach_record
      ~World.call
      ~World.checkpoint
      ~World.checkpoint_final_step
      ~World.checkpoint_info
      ~World.checkpoint_init
      ~World.checkpoint_on_step_started
      ~World.combine_stats
      ~World.complete_contract_execution
      ~World.contract_record
      ~World.contract_size
      ~World.create
      ~World.delete_executed_contracts
      ~World.draw
      ~World.executable_contracts
      ~World.execute_action
      ~World.extra_agent_info
      ~World.extra_neg_info
      ~World.extra_sim_step_info_post
      ~World.extra_sim_step_info_pre
      ~World.extract_action_info
      ~World.extract_agreement_info
      ~World.from_checkpoint
      ~World.from_config
      ~World.get_dropped_contracts
      ~World.get_private_state
      ~World.graph
      ~World.ignore_contract
      ~World.is_basic_stat
      ~World.is_valid_agreement
      ~World.is_valid_contract
      ~World.join
      ~World.logdebug
      ~World.logdebug_agent
      ~World.logerror
      ~World.logerror_agent
      ~World.loginfo
      ~World.loginfo_agent
      ~World.logwarning
      ~World.logwarning_agent
      ~World.n_saved_contracts
      ~World.on_contract_cancelled
      ~World.on_contract_concluded
      ~World.on_contract_processed
      ~World.on_contract_signed
      ~World.on_event
      ~World.on_exception
      ~World.on_negotiation_end
      ~World.on_negotiation_processed
      ~World.on_negotiation_start
      ~World.on_negotiation_stepped
      ~World.order_contracts_for_execution
      ~World.plot_combined_stats
      ~World.plot_stats
      ~World.post_step_stats
      ~World.pre_step_stats
      ~World.read_config
      ~World.register
      ~World.register_listener
      ~World.register_stats_monitor
      ~World.register_world_monitor
      ~World.request_negotiation_about
      ~World.run
      ~World.run_negotiation
      ~World.run_negotiations
      ~World.run_with_progress
      ~World.save_config
      ~World.save_gif
      ~World.set_bulletin_board
      ~World.set_id
      ~World.simulation_step
      ~World.spawn
      ~World.spawn_object
      ~World.start_contract_execution
      ~World.step
      ~World.type_name_for_logs
      ~World.unregister_stats_monitor
      ~World.unregister_world_monitor
      ~World.update_stats

   .. rubric:: Attributes Documentation

   .. autoattribute:: agreement_fraction
   .. autoattribute:: agreement_rate
   .. autoattribute:: breach_fraction
   .. autoattribute:: breach_level
   .. autoattribute:: breach_rate
   .. autoattribute:: business_size
   .. autoattribute:: cancellation_fraction
   .. autoattribute:: cancellation_rate
   .. autoattribute:: cancelled_contracts
   .. autoattribute:: contract_dropping_fraction
   .. autoattribute:: contract_err_fraction
   .. autoattribute:: contract_execution_fraction
   .. autoattribute:: contract_nullification_fraction
   .. autoattribute:: current_step
   .. autoattribute:: erred_contracts
   .. autoattribute:: executed_contracts
   .. autoattribute:: id
   .. autoattribute:: log_folder
   .. autoattribute:: n_agent_exceptions
   .. autoattribute:: n_contract_exceptions
   .. autoattribute:: n_mechanism_exceptions
   .. autoattribute:: n_negotiation_rounds_failed
   .. autoattribute:: n_negotiation_rounds_successful
   .. autoattribute:: n_negotiator_exceptions
   .. autoattribute:: n_simulation_exceptions
   .. autoattribute:: n_total_agent_exceptions
   .. autoattribute:: n_total_simulation_exceptions
   .. autoattribute:: name
   .. autoattribute:: nullified_contracts
   .. autoattribute:: relative_time
   .. autoattribute:: remaining_steps
   .. autoattribute:: remaining_time
   .. autoattribute:: resolved_breaches
   .. autoattribute:: saved_breaches
   .. autoattribute:: saved_contracts
   .. autoattribute:: saved_negotiations
   .. autoattribute:: short_type_name
   .. autoattribute:: signed_contracts
   .. autoattribute:: stat_names
   .. autoattribute:: stats
   .. autoattribute:: time
   .. autoattribute:: total_time
   .. autoattribute:: type_name
   .. autoattribute:: unresolved_breaches
   .. autoattribute:: uuid

   .. rubric:: Methods Documentation

   .. automethod:: action_info_cols
   .. automethod:: agreement_info_cols
   .. automethod:: announce
   .. automethod:: append_stats
   .. automethod:: breach_record
   .. automethod:: call
   .. automethod:: checkpoint
   .. automethod:: checkpoint_final_step
   .. automethod:: checkpoint_info
   .. automethod:: checkpoint_init
   .. automethod:: checkpoint_on_step_started
   .. automethod:: combine_stats
   .. automethod:: complete_contract_execution
   .. automethod:: contract_record
   .. automethod:: contract_size
   .. automethod:: create
   .. automethod:: delete_executed_contracts
   .. automethod:: draw
   .. automethod:: executable_contracts
   .. automethod:: execute_action
   .. automethod:: extra_agent_info
   .. automethod:: extra_neg_info
   .. automethod:: extra_sim_step_info_post
   .. automethod:: extra_sim_step_info_pre
   .. automethod:: extract_action_info
   .. automethod:: extract_agreement_info
   .. automethod:: from_checkpoint
   .. automethod:: from_config
   .. automethod:: get_dropped_contracts
   .. automethod:: get_private_state
   .. automethod:: graph
   .. automethod:: ignore_contract
   .. automethod:: is_basic_stat
   .. automethod:: is_valid_agreement
   .. automethod:: is_valid_contract
   .. automethod:: join
   .. automethod:: logdebug
   .. automethod:: logdebug_agent
   .. automethod:: logerror
   .. automethod:: logerror_agent
   .. automethod:: loginfo
   .. automethod:: loginfo_agent
   .. automethod:: logwarning
   .. automethod:: logwarning_agent
   .. automethod:: n_saved_contracts
   .. automethod:: on_contract_cancelled
   .. automethod:: on_contract_concluded
   .. automethod:: on_contract_processed
   .. automethod:: on_contract_signed
   .. automethod:: on_event
   .. automethod:: on_exception
   .. automethod:: on_negotiation_end
   .. automethod:: on_negotiation_processed
   .. automethod:: on_negotiation_start
   .. automethod:: on_negotiation_stepped
   .. automethod:: order_contracts_for_execution
   .. automethod:: plot_combined_stats
   .. automethod:: plot_stats
   .. automethod:: post_step_stats
   .. automethod:: pre_step_stats
   .. automethod:: read_config
   .. automethod:: register
   .. automethod:: register_listener
   .. automethod:: register_stats_monitor
   .. automethod:: register_world_monitor
   .. automethod:: request_negotiation_about
   .. automethod:: run
   .. automethod:: run_negotiation
   .. automethod:: run_negotiations
   .. automethod:: run_with_progress
   .. automethod:: save_config
   .. automethod:: save_gif
   .. automethod:: set_bulletin_board
   .. automethod:: set_id
   .. automethod:: simulation_step
   .. automethod:: spawn
   .. automethod:: spawn_object
   .. automethod:: start_contract_execution
   .. automethod:: step
   .. automethod:: type_name_for_logs
   .. automethod:: unregister_stats_monitor
   .. automethod:: unregister_world_monitor
   .. automethod:: update_stats