Skip to content

Latest commit

 

History

History
157 lines (100 loc) · 3.46 KB

message.md

File metadata and controls

157 lines (100 loc) · 3.46 KB

packages.fetchai.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(Message.Performative)

Performatives for the state_update protocol.

__str__

def __str__() -> str

Get the string representation.

__init__

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

Initialise an instance of StateUpdateMessage.

Arguments:

  • message_id: the message id.
  • dialogue_reference: the dialogue reference.
  • target: the message target.
  • performative: the message performative.
  • **kwargs: extra options.

valid_performatives

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

Get valid performatives.

dialogue_reference

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

Get the dialogue_reference of the message.

message_id

@property
def message_id() -> int

Get the message_id of the message.

performative

@property
def performative() -> Performative

Get the performative of the message.

target

@property
def target() -> int

Get the target of the message.

amount_by_currency_id

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

Get the 'amount_by_currency_id' content from the message.

exchange_params_by_currency_id

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

Get the 'exchange_params_by_currency_id' content from the message.

quantities_by_good_id

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

Get the 'quantities_by_good_id' content from the message.

utility_params_by_good_id

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

Get the 'utility_params_by_good_id' content from the message.