trackable.hpp

Go to the documentation of this file.

#pragma once
/*
 * Copyright (c) 2013 Aldebaran Robotics. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the COPYING file.
 */


#ifndef _QI_TRACKABLE_HPP_
#define _QI_TRACKABLE_HPP_

#include <boost/thread/mutex.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/condition_variable.hpp>
#include <boost/function.hpp>

#include <qi/log.hpp>

namespace qi
{

  class TrackableBase {};

  template<typename T>
  class Trackable: public TrackableBase
  {
  public:
    Trackable(T* ptr);
    ~Trackable();

    boost::shared_ptr<T> lock();

    boost::weak_ptr<T>   weakPtr();

    void wait();
  protected:
    void destroy();
  private:
    void _destroyed();

    boost::shared_ptr<T>      _ptr;
    boost::condition_variable _cond;
    boost::mutex              _mutex;
    bool                      _wasDestroyed;
  };

  class QI_API PointerLockException: public std::exception
  {
  public:
    virtual const char* what() const throw()
    {
      return "Pointer Lock failed";
    }
  };

#ifdef DOXYGEN

  template<typename RF, typename AF> boost::function<RF> bind(const AF& fun, ...);
#endif

  template<typename F, typename ARG0>
  boost::function<F> track(const boost::function<F>& f, const ARG0& arg0);
  template<typename F, typename ARG0>
  boost::function<F> trackWithFallback(boost::function<void()> onFail,
      const boost::function<F>& f, const ARG0& arg0);
}

#include <qi/details/trackable.hxx>
#endif  // _QI_TRACKABLE_HPP_