Class to find and enumerate running tasks.
More...
#include <taskmanager.h>
|
bool | running (const std::string &task_name) const |
| Check if a task is running. More...
|
|
std::string | name (TaskHandle handle) const |
| Return name of task from a handle. More...
|
|
TaskHandle | find_first (const std::string &task_name) const |
| Find the first running task with the given name. More...
|
|
bool | find_first (TaskInfo &info, const std::string &task_name) const |
| Find first running task with given name and return full info. More...
|
|
bool | find_all (std::vector< TaskInfo > &infos, const std::string &task_name) const |
| Find all running tasks with given name and return full info. More...
|
|
void | list (std::vector< TaskInfo > &infos) const |
| Get list of all running tasks. More...
|
|
Class to find and enumerate running tasks.
bool tbx::TaskManager::find_all |
( |
std::vector< TaskInfo > & |
infos, |
|
|
const std::string & |
task_name |
|
) |
| const |
Find all running tasks with given name and return full info.
- Parameters
-
infos | vector of task information for found tasks |
task_name | name of task to find |
- Returns
- true if on or more tasks were.
TaskHandle tbx::TaskManager::find_first |
( |
const std::string & |
task_name | ) |
const |
Find the first running task with the given name.
- Parameters
-
task_name | name of task to find |
- Returns
- Handle to task or 0 if not found
bool tbx::TaskManager::find_first |
( |
TaskInfo & |
info, |
|
|
const std::string & |
task_name |
|
) |
| const |
Find first running task with given name and return full info.
- Parameters
-
info | task information filled in if task name found |
task_name | name of task to find |
- Returns
- true if task is found in which case info is valid.
void tbx::TaskManager::list |
( |
std::vector< TaskInfo > & |
infos | ) |
const |
Get list of all running tasks.
- Parameters
-
info | task information for all tasks |
std::string tbx::TaskManager::name |
( |
TaskHandle |
handle | ) |
const |
Return name of task from a handle.
- Parameters
-
handle | TaskHandle to get name for |
- Returns
- name of task
- Exceptions
-
bool tbx::TaskManager::running |
( |
const std::string & |
task_name | ) |
const |
Check if a task is running.
- Parameters
-
task_name | name of task to search for |
- Returns
- true if the task is running
The documentation for this class was generated from the following files: