openpectus.engine.engine_message_builder

Attributes

logger

frontend_logging_queue

frontend_logging_handler

Classes

EngineMessageBuilder

Collects data from engine and constructs engine messages

Functions

to_model_tag(tag)

Module Contents

openpectus.engine.engine_message_builder.logger
openpectus.engine.engine_message_builder.frontend_logging_queue: queue.SimpleQueue[logging.LogRecord]
openpectus.engine.engine_message_builder.frontend_logging_handler
openpectus.engine.engine_message_builder.to_model_tag(tag)
Parameters:

tag (openpectus.lang.exec.tags.TagValue)

Return type:

openpectus.protocol.models.TagValue

class openpectus.engine.engine_message_builder.EngineMessageBuilder(engine)

Collects data from engine and constructs engine messages

Parameters:

engine (openpectus.engine.engine.Engine)

engine
__str__()
Return type:

str

create_uod_info()
Return type:

openpectus.protocol.engine_messages.UodInfoMsg

collect_tag_updates(snapshot=False)
Return type:

list[openpectus.protocol.models.TagValue]

create_tag_updates_snapshot_msg()
Return type:

openpectus.protocol.engine_messages.TagsUpdatedMsg

create_tag_updates_msg()
Return type:

openpectus.protocol.engine_messages.TagsUpdatedMsg | None

create_run_started_msg(run_id, tick_time)
Parameters:
  • run_id (str)

  • tick_time (float)

Return type:

openpectus.protocol.engine_messages.RunStartedMsg

create_run_stopped_msg(run_id)
Parameters:

run_id (str)

Return type:

openpectus.protocol.engine_messages.RunStoppedMsg

create_runlog_msg(run_id)
Parameters:

run_id (str)

Return type:

openpectus.protocol.engine_messages.RunLogMsg

create_error_log_msg()
Return type:

openpectus.protocol.engine_messages.ErrorLogMsg | None

create_control_state_msg()
Return type:

openpectus.protocol.engine_messages.ControlStateMsg

create_method_state_msg()
Return type:

openpectus.protocol.engine_messages.MethodStateMsg

create_method_msg()
Return type:

openpectus.protocol.engine_messages.MethodMsg

create_wpn_run_stopped_msg()
Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_run_started_msg()
Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_run_paused_msg()
Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_block_started_msg(block_name)
Parameters:

block_name (str)

Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_notify_command_msg(text)
Parameters:

text (str)

Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_watch_activated_msg(watch_argument)
Parameters:

watch_argument (str)

Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_method_error_msg()
Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg

create_wpn_network_error_msg()
Return type:

openpectus.protocol.engine_messages.WebPushNotificationMsg