The steerable interface is implemented by saga objects which can be steered, i.e. which have writable metrics, and which might allow to add new metrics. More...
#include <monitorable.hpp>
Inheritance diagram for saga::steerable:
Public Member Functions | |
| steerable (saga::object rhs) | |
| Brief description starts here. | |
| steerable (saga::impl::object *impl) | |
| Brief description starts here. | |
| virtual | ~steerable (void) |
| Brief description starts here. | |
| virtual bool | add_metric (saga::metric m) |
| Adds a metric instance to the application instance. | |
| virtual void | remove_metric (std::string name) |
| Removes a metric instance. | |
| virtual void | fire_metric (std::string name) |
| Pushes a new metric value to the backend. | |
Detailed Description
The steerable interface is implemented by saga objects which can be steered, i.e. which have writable metrics, and which might allow to add new metrics.
Steerable objects also implement the monitorable interface. The method add_metric() allows to implement steerable applications. In particular, the saga::self object is steerable, and allows to add metrics.
Definition at line 117 of file monitorable.hpp.
Constructor & Destructor Documentation
| saga::steerable::steerable | ( | saga::object | rhs | ) |
Brief description starts here.
Definition at line 63 of file monitorable.cpp.
| saga::steerable::steerable | ( | saga::impl::object * | impl | ) | [explicit] |
Brief description starts here.
Definition at line 68 of file monitorable.cpp.
| saga::steerable::~steerable | ( | void | ) | [virtual] |
Brief description starts here.
Definition at line 73 of file monitorable.cpp.
Member Function Documentation
| bool saga::steerable::add_metric | ( | saga::metric | m | ) | [virtual] |
Adds a metric instance to the application instance.
- Parameters:
-
metric Metric to be added.
- Returns:
- Indicates the success.
Definition at line 87 of file monitorable.cpp.
| void saga::steerable::remove_metric | ( | std::string | name | ) | [virtual] |
Removes a metric instance.
- Parameters:
-
name Identifies the metric to be removed
Definition at line 92 of file monitorable.cpp.
| void saga::steerable::fire_metric | ( | std::string | name | ) | [virtual] |
Pushes a new metric value to the backend.
- Parameters:
-
name Identifies the metric to be fired.
Definition at line 97 of file monitorable.cpp.
The documentation for this class was generated from the following files:
