saga::monitorable Class Reference

The monitorable interface is implemented by those SAGA objects which can be monitored, i.e. which have one or more associated metrics. More...

#include <monitorable.hpp>

Inheritance diagram for saga::monitorable:

[legend]

List of all members.

Public Types

typedef unsigned int cookie_handle

Brief description starts here.

Public Member Functions

monitorable (saga::object rhs)

Brief description starts here.

monitorable (saga::impl::object *impl)

Brief description starts here.

virtual ~monitorable (void)

Brief description starts here.

virtual std::vector< saga::metric > list_metrics (void) const

Brief description starts here.

virtual saga::metric get_metric (std::string name) const

Returns a metric instance, identified by name.

virtual cookie_handle add_callback (std::string name, saga::callback cb)

Adds a callback to the specified metric.

virtual void remove_callback (std::string name, cookie_handle cookie)

Removes a callback from the specified metric.

Detailed Description

The monitorable interface is implemented by those SAGA objects which can be monitored, i.e. which have one or more associated metrics.

The interface allows introspection of these metrics, and allows to add callbacks to these metrics which get called if these metrics change. Several methods of this interface reflect similar methods on the metric class

the additional string argument name identifies the metric these methods act upon.