SAGA C++ API 1.6
saga::detail::steerable< Derived > Struct Template Reference

The SAGA steerable interface. More...

#include <steerable.hpp>

Inheritance diagram for saga::detail::steerable< Derived >:

List of all members.

Public Member Functions

bool add_metric (saga::metric m)
 Adds a metric to this object instance.
void remove_metric (std::string name)
 Removes a metric from this object instance.
void fire_metric (std::string name)
 Push a new metric value to the backend.

Detailed Description

template<typename Derived>
struct saga::detail::steerable< Derived >

The SAGA steerable interface.

TODO .

Definition at line 50 of file steerable.hpp.


Member Function Documentation

template<typename Derived >
bool saga::detail::steerable< Derived >::add_metric ( saga::metric  m) [inline]

Adds a metric to this object instance.

Parameters:
mThe metric to add

TODO .

Definition at line 34 of file steerable_impl.hpp.

References saga::IncorrectState.

template<typename Derived >
void saga::detail::steerable< Derived >::remove_metric ( std::string  name) [inline]

Removes a metric from this object instance.

Parameters:
nameThe metric's name

TODO .

Definition at line 45 of file steerable_impl.hpp.

References saga::IncorrectState.

template<typename Derived >
void saga::detail::steerable< Derived >::fire_metric ( std::string  name) [inline]

Push a new metric value to the backend.

Parameters:
nameThe metric to be fired

TODO .

Definition at line 56 of file steerable_impl.hpp.

References saga::IncorrectState.


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