pid
Classes | Namespaces | Typedefs | Enumerations | Functions

header for common definitions of the loops library More...

#include <cstdint>
#include <string>
#include <variant>
Include dependency graph for loop_common.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  pid::loops::LoopLifeCycleNotification
 
struct  pid::loops::EventNotification
 
struct  pid::loops::LoopTimingConfiguration
 
struct  pid::loops::LoopSynchroConfiguration
 

Namespaces

 pid
 root namespace for pid packages.
 
 pid::loops
 

Typedefs

using pid::loops::LoopMessage = std::variant< EventNotification, LoopLifeCycleCommand, LoopLifeCycleNotification, LoopTimingConfiguration, LoopSynchroConfiguration >
 

Enumerations

enum  pid::loops::LoopLifeCycleCommand : std::uint8_t {
  pid::loops::LoopLifeCycleCommand::STARTUP, pid::loops::LoopLifeCycleCommand::INIT, pid::loops::LoopLifeCycleCommand::TERMINATE, pid::loops::LoopLifeCycleCommand::PAUSE,
  pid::loops::LoopLifeCycleCommand::START, pid::loops::LoopLifeCycleCommand::KILL
}
 
enum  pid::loops::LoopLifeCycle : std::uint8_t {
  pid::loops::LoopLifeCycle::NOT_STARTED, pid::loops::LoopLifeCycle::NOT_INITIALIZED, pid::loops::LoopLifeCycle::INITIALIZING, pid::loops::LoopLifeCycle::INITIALIZED,
  pid::loops::LoopLifeCycle::RUNNING, pid::loops::LoopLifeCycle::EXECUTING, pid::loops::LoopLifeCycle::STOPPING, pid::loops::LoopLifeCycle::TERMINATING,
  pid::loops::LoopLifeCycle::KILLED, pid::loops::LoopLifeCycle::ERROR
}
 
enum  pid::loops::LifeCycleManagement : std::uint8_t {
  pid::loops::LifeCycleManagement::FAILED, pid::loops::LifeCycleManagement::KILLED, pid::loops::LifeCycleManagement::OK, pid::loops::LifeCycleManagement::INTERRUPTED,
  pid::loops::LifeCycleManagement::BAD_CALL
}
 
enum  pid::loops::TimingCommand : std::uint8_t { pid::loops::TimingCommand::NEW_PERIOD, pid::loops::TimingCommand::NEW_DELAY }
 
enum  pid::loops::LoopSynchroConfigurationCmd : std::uint8_t { pid::loops::LoopSynchroConfigurationCmd::RESET_PATTERN, pid::loops::LoopSynchroConfigurationCmd::ADD_CLAUSE, pid::loops::LoopSynchroConfigurationCmd::ADD_UNION }
 

Functions

std::string pid::loops::to_string (LoopLifeCycleCommand command)
 
std::string pid::loops::to_string (LoopLifeCycle life_cycle)
 
std::string pid::loops::to_string (LifeCycleManagement life_cycle)
 

Detailed Description

header for common definitions of the loops library

Author
Robin Passama
Date
2022-06-10