mirror of
https://git.intern.spaceteamaachen.de/ALPAKA/TACOS.git
synced 2025-08-06 01:37:33 +00:00
Added a simple API for TACOS
This commit is contained in:
60
include/sta/tacos.hpp
Normal file
60
include/sta/tacos.hpp
Normal file
@@ -0,0 +1,60 @@
|
||||
/*
|
||||
* tacos.hpp
|
||||
*
|
||||
* Created on: Jan 2, 2024
|
||||
* Author: Dario
|
||||
*/
|
||||
|
||||
#ifndef STA_TACOS_HPP
|
||||
#define STA_TACOS_HPP
|
||||
|
||||
#include <sta/tacos/thread.hpp>
|
||||
#include <sta/tacos/manager.hpp>
|
||||
#include <sta/tacos/statemachine.hpp>
|
||||
|
||||
#include <initializer_list>
|
||||
|
||||
|
||||
namespace sta
|
||||
{
|
||||
namespace tacos
|
||||
{
|
||||
/**
|
||||
* @brief Get the current state of the TACOS statemachine.
|
||||
*
|
||||
* @return uint16_t Returns the state.
|
||||
*/
|
||||
uint16_t getState();
|
||||
|
||||
/**
|
||||
* @brief Request a state transition. Invalid state transitions will be dismissed.
|
||||
*
|
||||
* @param from The start we want to transition from.
|
||||
* @param to The state we want to transition to.
|
||||
* @param lockout An optional timer blocking state transition for a given time.
|
||||
*/
|
||||
void setState(uint32_t from, uint32_t to, uint32_t lockout = 0);
|
||||
|
||||
/**
|
||||
* @brief Request a state transition after a given time has passed. Invalid state transitions will be dismissed.
|
||||
*
|
||||
* @param from The start we want to transition from.
|
||||
* @param to The state we want to transition to.
|
||||
* @param millis The time to wait until the transition is requested.
|
||||
* @param lockout An optional timer blocking state transition for a given time. Will be active after this transition was executed.
|
||||
*/
|
||||
void setStateTimed(uint32_t from, uint32_t to, uint32_t millis, uint32_t lockout = 0);
|
||||
|
||||
/**
|
||||
* @brief Register a new thread to be run by TACOS.
|
||||
*
|
||||
* @tparam T The class of the thread to be created. A subclass of TacosThread.
|
||||
* @param states A list of states in which the thread should run.
|
||||
* @param args The constructor arguments for the provided class.
|
||||
*/
|
||||
template<typename T>
|
||||
void addThread(std::list<uint16_t> states, std::initializer_list<T> args);
|
||||
} // namespace tacos
|
||||
}
|
||||
|
||||
#endif /* STA_TACOS_HPP */
|
Reference in New Issue
Block a user