betfsm.Message

Bases: Generator

Message(msg="my_message") returns a State that displays a message Message(cb=function) returns a State that displays a message generated by the given function The argument name="..." specifies the name of the Message state.

__init__(name=None, *, msg=None, cb=None, logCategory='default')

Displays a message to the log.

Parameters:
  • name (str, default: None ) –

    instance name, default message

  • msg (str, default: None ) –

    string describing the message

  • cb (Callable, default: None ) –

    callback returning the message. Signature def cb(blackboard)->str. The callback allows the user to compute the message at time of evaluation, e.g. to report on values on the blackboard.

  • logCategory (str, default: 'default' ) –

    the category under which to log the message

warning

Only one of the arguments msg or cb can be specified

example
Message(lambda bb: f'{bb["some_key_in_blackboard"]=}' )