sequencer.hh

Go to the documentation of this file.

/*
 * Copyright 2010,
 * François Bleibel,
 * Olivier Stasse,
 *
 * CNRS/AIST
 *
 */

#ifndef __SOT_SOTSEQUENCER_H__
#define __SOT_SOTSEQUENCER_H__

/* --------------------------------------------------------------------- */
/* --- INCLUDE --------------------------------------------------------- */
/* --------------------------------------------------------------------- */

/* Matrix */
#include <dynamic-graph/linear-algebra.h>

/* SOT */
#include <dynamic-graph/all-signals.h>
#include <dynamic-graph/entity.h>

#include <sot/core/task-abstract.hh>

/* STD */
#include <list>
#include <map>
#include <string>

/* --------------------------------------------------------------------- */
/* --- API ------------------------------------------------------------- */
/* --------------------------------------------------------------------- */

#if defined(WIN32)
#if defined(sequencer_EXPORTS)
#define SOTSEQUENCER_EXPORT __declspec(dllexport)
#else
#define SOTSEQUENCER_EXPORT __declspec(dllimport)
#endif
#else
#define SOTSEQUENCER_EXPORT
#endif

namespace dynamicgraph {
namespace sot {

/* --------------------------------------------------------------------- */
/* --- CLASS ----------------------------------------------------------- */
/* --------------------------------------------------------------------- */

class Sot;

class SOTSEQUENCER_EXPORT Sequencer : public dynamicgraph::Entity {
  DYNAMIC_GRAPH_ENTITY_DECL();

 public:
  class sotEventAbstract {
   public:
    enum sotEventType { EVENT_ADD, EVENT_RM, EVENT_CMD };

   protected:
    std::string name;
    void setName(const std::string &name_) { name = name_; }
    int eventType;

   public:
    sotEventAbstract(const std::string &name) : name(name){};
    virtual ~sotEventAbstract(void) {}
    virtual const std::string &getName() const { return name; }
    int getEventType() const { return eventType; }
    virtual void operator()(Sot *sotPtr) = 0;
    virtual void display(std::ostream &os) const { os << name; }
  };

 protected:
  Sot *sotPtr;
  typedef std::list<sotEventAbstract *> TaskList;
  typedef std::map<unsigned int, TaskList> TaskMap;

  TaskMap taskMap;
  /* All the events are counting wrt to this t0. If t0 is -1, it
   * is set to the first time of trig.    */
  int timeInit;
  bool playMode;
  std::ostream *outputStreamPtr;
  bool noOutput; 
 public: /* --- CONSTRUCTION --- */
  Sequencer(const std::string &name);
  virtual ~Sequencer(void);

 public: /* --- TASK MANIP --- */
  void setSotRef(Sot *sot) { sotPtr = sot; }
  void addTask(sotEventAbstract *task, const unsigned int time);
  void rmTask(int eventType, const std::string &name, const unsigned int time);
  void clearAll();

 public: /* --- SIGNAL --- */
  dynamicgraph::SignalTimeDependent<int, int> triggerSOUT;

 public: /* --- FUNCTIONS --- */
  int &trigger(int &dummy, const int &time);

 public: /* --- PARAMS --- */
  virtual void display(std::ostream &os) const;
};
}  // namespace sot
}  // namespace dynamicgraph

#endif  // #ifndef __SOT_SOTSEQUENCER_H__