SAGA C++ API 1.5.3

saga::metric Class Reference

Brief description starts here. More...

#include <metric.hpp>

Inheritance diagram for saga::metric:

List of all members.

Public Types

enum  frequency {
  Unknown = -1,
  Cont = 0,
  Descreet = 1,
  Pull = 2,
  Push = 3,
  Event = 4
}
 

Brief description starts here.

More...
typedef
saga::monitorable::cookie_handle 
metric_cookie
 Brief description starts here.

Public Member Functions

 metric (void)
 Brief description starts here.
 metric (saga::object const &o)
 Brief description starts here.
 metric (saga::object target, std::string name, std::string desc, std::string mode, std::string unit, std::string type, std::string val)
 Brief description starts here.
 ~metric (void)
 Brief description starts here.
metricoperator= (saga::object const &o)
 Brief description starts here.
void fire (saga::context ctx=saga::context())
 Brief description starts here.
metric_cookie add_callback (saga::callback f)
 Brief description starts here.
void remove_callback (metric_cookie cookie)
 Brief description starts here.

Protected Member Functions

saga::impl::metric * get_impl (void) const
 @ TR1::shared_ptr <saga::impl::metric> get_impl_sp (void) const;
 metric (saga::impl::metric *impl)

Friends

bool operator== (metric const &lhs, metric const &rhs)
 Brief description starts here.

Detailed Description

Brief description starts here.


Member Typedef Documentation

Brief description starts here.


Member Enumeration Documentation

Brief description starts here.

Enumerator:
Unknown 
Cont 
Descreet 
Pull 
Push 
Event 

Constructor & Destructor Documentation

saga::metric::metric ( saga::impl::metric *  impl) [explicit, protected]
saga::metric::metric ( void  )

Brief description starts here.

saga::metric::metric ( saga::object const &  o) [explicit]

Brief description starts here.

References saga::BadParameter, saga::object::get_type(), and saga::object::Metric.

saga::metric::~metric ( void  )

Brief description starts here.


Member Function Documentation

saga::impl::metric * saga::metric::get_impl ( void  ) const [protected]

@ TR1::shared_ptr <saga::impl::metric> get_impl_sp (void) const;

Reimplemented from saga::object.

Referenced by add_callback(), fire(), saga::operator==(), and remove_callback().

metric & saga::metric::operator= ( saga::object const &  o)

Brief description starts here.

References saga::BadParameter, saga::object::get_type(), and saga::object::Metric.

metric::metric_cookie saga::metric::add_callback ( saga::callback  f)

Brief description starts here.

References get_impl().

void saga::metric::remove_callback ( metric_cookie  cookie)

Brief description starts here.

References get_impl().


Friends And Related Function Documentation

bool operator== ( metric const &  lhs,
metric const &  rhs 
) [friend]

Brief description starts here.


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