taskolib/Context_8h_source.html

 // SPDX-License-Identifier: LGPL-2.1-or-later


 #ifndef TASKOLIB_CONTEXT_H_

 #define TASKOLIB_CONTEXT_H_


 #include <functional>

 #include <string>

 #include <unordered_map>

 #include <variant>


 #include "sol/sol.hpp"

 #include "taskolib/CommChannel.h"

 #include "taskolib/default_message_callback.h"

 #include "taskolib/Message.h"

 #include "taskolib/StepIndex.h"

 #include "taskolib/VariableName.h"


 namespace task {


 using LuaInteger = LUA_INTEGER;

 using LuaFloat = LUA_NUMBER;

 using LuaString = std::string;

 using LuaBool = bool;


 using VarInteger = long long;

 using VarFloat = double;

 using VarString = std::string;

 using VarBool = bool;


 using VariableValue = std::variant<

     VarInteger,

     VarFloat,

     VarString,

     VarBool>;


 using VariableTable = std::unordered_map<VariableName, VariableValue>;


 using MessageCallback = std::function<void(const Message&)>;


 struct Context

 {

     VariableTable variables;


     std::string step_setup_script = "";


     std::function<void(sol::state&)> step_setup_function;


     MessageCallback message_callback_function = default_message_callback;

 };


 } // namespace task


 #endif

CommChannel.h
Declaration of the CommChannel struct.

Message.h
Declaration of the Message class.

StepIndex.h
Declaration of the StepIndex type.

VariableName.h
Declaration of the VariableName class and of an associated specialization of std::hash.

task::Message
A message carrying some text, a timestamp, and a type, to be transported with a message queue between...
Definition: Message.h:45

default_message_callback.h
Declaration of the default_message_callback() function.

task
Namespace task contains all Taskolib functions and classes.
Definition: CommChannel.h:33

task::VarInteger
long long VarInteger
Storage type for integral numbers.
Definition: Context.h:55

task::LuaString
std::string LuaString
The string type used by the Lua interpreter.
Definition: Context.h:49

task::VarBool
bool VarBool
Storage type for booleans.
Definition: Context.h:58

task::LuaInteger
LUA_INTEGER LuaInteger
The integer type used by the Lua interpreter.
Definition: Context.h:47

task::default_message_callback
void default_message_callback(const Message &msg)
Default callback function for messages.
Definition: default_message_callback.cc:30

task::MessageCallback
std::function< void(const Message &)> MessageCallback
A message callback function receives a Message object as a parameter.
Definition: Context.h:86

task::LuaFloat
LUA_NUMBER LuaFloat
The floating point type used by the Lua interpreter.
Definition: Context.h:48

task::VariableValue
std::variant< VarInteger, VarFloat, VarString, VarBool > VariableValue
A VariableValue is a variant over all Variable types.
Definition: Context.h:73

task::VarFloat
double VarFloat
Storage type for floatingpoint number.
Definition: Context.h:56

task::LuaBool
bool LuaBool
The boolean type used by the Lua interpreter.
Definition: Context.h:50

task::VarString
std::string VarString
Storage type for strings.
Definition: Context.h:57

task::VariableTable
std::unordered_map< VariableName, VariableValue > VariableTable
Associative table that holds Lua variable names and their value.
Definition: Context.h:80

task::Context
A context stores information that influences the execution of steps and sequences,...
Definition: Context.h:128

task::Context::step_setup_function
std::function< void(sol::state &)> step_setup_function
An initialization function that is called on a Lua state before a step is executed.
Definition: Context.h:137

task::Context::message_callback_function
MessageCallback message_callback_function
A callback (or "hook") function that is invoked whenever a message is processed during the execution ...
Definition: Context.h:143

task::Context::step_setup_script
std::string step_setup_script
Step setup script with common functions or constants like a small library.
Definition: Context.h:134

task::Context::variables
VariableTable variables
A map of variables (names and values) that can be im-/exported into steps.
Definition: Context.h:130