aea.protocols.state_update.message

This module contains state_update's message definition.

StateUpdateMessage Objects

class StateUpdateMessage(Message)

A protocol for state updates to the decision maker state.

Performative Objects

class Performative(Enum)

Performatives for the state_update protocol.

__str__

 | __str__()

Get the string representation.

__init__

 | __init__(performative: Performative, dialogue_reference: Tuple[str, str] = ("", ""), message_id: int = 1, target: int = 0, **kwargs, ,)

Initialise an instance of StateUpdateMessage.

Arguments:

  • message_id: the message id.
  • dialogue_reference: the dialogue reference.
  • target: the message target.
  • performative: the message performative.

valid_performatives

 | @property
 | valid_performatives() -> Set[str]

Get valid performatives.

dialogue_reference

 | @property
 | dialogue_reference() -> Tuple[str, str]

Get the dialogue_reference of the message.

message_id

 | @property
 | message_id() -> int

Get the message_id of the message.

performative

 | @property
 | performative() -> Performative

Get the performative of the message.

target

 | @property
 | target() -> int

Get the target of the message.

amount_by_currency_id

 | @property
 | amount_by_currency_id() -> Dict[str, int]

Get the 'amount_by_currency_id' content from the message.

exchange_params_by_currency_id

 | @property
 | exchange_params_by_currency_id() -> Dict[str, float]

Get the 'exchange_params_by_currency_id' content from the message.

quantities_by_good_id

 | @property
 | quantities_by_good_id() -> Dict[str, int]

Get the 'quantities_by_good_id' content from the message.

utility_params_by_good_id

 | @property
 | utility_params_by_good_id() -> Dict[str, float]

Get the 'utility_params_by_good_id' content from the message.