monitorable.hpp

Go to the documentation of this file.

//  Copyright (c) 2005-2009 Hartmut Kaiser
//  Copyright (c) 2007 Ole Weidner (oweidner@cct.lsu.edu)
// 
//  Distributed under the Boost Software License, Version 1.0. (See accompanying 
//  file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#ifndef SAGA_MONITORABLE_HPP
#define SAGA_MONITORABLE_HPP

// include STL
#include <string>
#include <vector>

// include dependent spec sections
#include <saga/saga/util.hpp>
#include <saga/saga/base.hpp>

// suppress warnings about dependent classes not being exported from the dll
#if defined(BOOST_MSVC)
#pragma warning(push)
#pragma warning(disable : 4251 4231 4660)
#endif

namespace saga
{

    typedef bool callback_function_type(saga::object, saga::metric, saga::context);
    typedef TR1::function<callback_function_type> callback;
    
    class SAGA_EXPORT monitorable
    {
    protected:

        TR1::shared_ptr <saga::impl::object> impl_;

        saga::impl::monitorable* get_monitorable (void);
        saga::impl::monitorable const* get_monitorable (void) const;

    public:
        typedef unsigned int cookie_handle;
        
        monitorable (saga::object rhs);
        
        explicit monitorable (saga::impl::object *impl);    // adaptor interface
    
        virtual ~monitorable (void);
        
        virtual std::vector<saga::metric> list_metrics (void) const;
        
        virtual saga::metric get_metric (std::string name) const;

        virtual cookie_handle add_callback (std::string name, saga::callback cb);
        
        virtual void remove_callback (std::string name, cookie_handle  cookie);
    };

    class SAGA_EXPORT steerable
    :   public monitorable
    {
    protected:

        saga::impl::steerable* get_steerable (void);
        saga::impl::steerable const* get_steerable (void) const;

    public:
        steerable (saga::object rhs);
        
        explicit steerable (saga::impl::object *impl);    // adaptor interface

        virtual ~steerable (void);
        
        virtual bool add_metric (saga::metric m);
        
        virtual void remove_metric (std::string name);
        
        virtual void fire_metric (std::string name);
    };

} // namespace saga
                                                                             
#if defined(BOOST_MSVC)
#pragma warning(pop)
#endif

#endif // SAGA_MONITORABLE_HPP