periodic-call-entity.hh

Go to the documentation of this file.

/*
 * Copyright 2010,
 * François Bleibel,
 * Olivier Stasse,
 *
 * CNRS/AIST
 *
 */
 
#ifndef __SOT_PERIODICCALL_ENTITY_HH__
#define __SOT_PERIODICCALL_ENTITY_HH__
 
/* --------------------------------------------------------------------- */
/* --- INCLUDE --------------------------------------------------------- */
/* --------------------------------------------------------------------- */
 
/* SOT */
#include <dynamic-graph/all-signals.h>
#include <dynamic-graph/entity.h>
 
#include <sot/core/periodic-call-entity.hh>
#include <sot/core/periodic-call.hh>
/* STD */
#include <list>
#include <map>
#include <string>
 
/* --------------------------------------------------------------------- */
/* --- API ------------------------------------------------------------- */
/* --------------------------------------------------------------------- */
 
#if defined(WIN32)
#if defined(periodic_call_entity_EXPORTS)
#define PeriodicCallEntity_EXPORT __declspec(dllexport)
#else
#define PeriodicCallEntity_EXPORT __declspec(dllimport)
#endif
#else
#define PeriodicCallEntity_EXPORT
#endif
 
/* --------------------------------------------------------------------- */
/* --- CLASS ----------------------------------------------------------- */
/* --------------------------------------------------------------------- */
 
namespace dynamicgraph {
namespace sot {
 
class PeriodicCallEntity_EXPORT PeriodicCallEntity
    : public Entity,
      protected sot::PeriodicCall {
 public:
  static const std::string CLASS_NAME;
  virtual const std::string &getClassName(void) const { return CLASS_NAME; }
 
  Signal<size_type, sigtime_t> triger;
  Signal<size_type, sigtime_t> trigerOnce;
 
  size_type &trigerCall(size_type &dummy, const sigtime_t &time);
  size_type &trigerOnceCall(size_type &dummy, const sigtime_t &time);
 
  /* --- FUNCTIONS ------------------------------------------------------------
   */
 public:
  PeriodicCallEntity(const std::string &name);
  virtual ~PeriodicCallEntity(void) {}
 
  virtual void display(std::ostream &os) const;
};
 
}  // namespace sot
}  // namespace dynamicgraph
 
#endif  // #ifndef __SOT_PERIODICCALL_ENTITY_HH__
 
/*
 * Local variables:
 * c-basic-offset: 2
 * End:
 */