SAGA C++ API 1.5.3

saga::steerable Class Reference

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:

List of all members.

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.

Protected Member Functions

saga::impl::steerable * get_steerable (void)
 @ /** These methods are not within API scope */
saga::impl::steerable const * get_steerable (void) const

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.


Constructor & Destructor Documentation

saga::steerable::steerable ( saga::object  rhs)

Brief description starts here.

saga::steerable::steerable ( saga::impl::object *  impl) [explicit]

Brief description starts here.

saga::steerable::~steerable ( void  ) [virtual]

Brief description starts here.


Member Function Documentation

saga::impl::steerable * saga::steerable::get_steerable ( void  ) [protected]

@ /** These methods are not within API scope */

References saga::monitorable::impl_.

Referenced by fire_metric(), and remove_metric().

saga::impl::steerable const * saga::steerable::get_steerable ( void  ) const [protected]
bool saga::steerable::add_metric ( saga::metric  m) [inline, virtual]

Adds a metric instance to the application instance.

Parameters:
metricMetric to be added.
Returns:
Indicates the success.

References saga::IncorrectState.

void saga::steerable::remove_metric ( std::string  name) [virtual]

Removes a metric instance.

Parameters:
nameIdentifies the metric to be removed

References get_steerable().

void saga::steerable::fire_metric ( std::string  name) [virtual]

Pushes a new metric value to the backend.

Parameters:
nameIdentifies the metric to be fired.

References get_steerable().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines