sani7/remote-ui
1
0
Fork 0
mirror of https://github.com/Sani7/remote-ui.git synced 2026-10-27 06:01:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

simulator_base

Browse Source 
add Doxygen documentation for the people using this class
This commit is contained in:
sani7
2024-08-22 13:12:22 +02:00
parent 33eb776c57
commit f910643e04
1 changed files with 49 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/simulator_base.hpp
+49
View File
@@ -6,20 +6,69 @@
class Simulator_base {
public:
/**
* @brief Construct a new Simulator_base object
*
* @param name The name of the simulator
* @param interval The interval of the timer (default is 100ms)
*/
Simulator_base(std::string name, std::chrono::milliseconds interval = std::chrono::milliseconds(100));
/**
* @brief Returns the name of the simulator
*
* @return std::string The name of the simulator
*/
std::string name() const;
/**
* @brief This function checks if the UI id is unique
* (hence not already pushed in with the add_UI_item function)
*
* @param id The id to check
* @return true The id is unique
* @return false The id is already in use
*/
bool is_ui_id_unique(std::string id) const;
/**
* @brief This function adds a UI item to the simulator
* only if the id is unique
* Use this function only in the constructor of the simulator
*
* @param item The UI item to add
*/
void add_UI_item(UI_item* item);
/**
* @brief Get the UI items object
*
* @return json The UI items in json format
*/
json get_UI_items() const;
/**
* @brief Get the UI item object by id
*
* @param id The id of the UI item
* @return UI_item* A pointer to the UI item object
*/
UI_item* get_UI_item(std::string id) const;
/**
* @brief Run the simulator
*/
void run();
/**
* @brief Stop the simulator
*/
void stop();
/**
* @brief Timer function
* This function is called every time the timer ticks
* Override this function in the derived class
*/
virtual void timer() {};
protected:
std::string p_name;