feature-generic.hh

Go to the documentation of this file.

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

#ifndef __SOT_FEATURE_GENERIC_HH__
#define __SOT_FEATURE_GENERIC_HH__

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

/* SOT */
#include <sot/core/exception-task.hh>
#include <sot/core/feature-abstract.hh>

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

#if defined(WIN32)
#if defined(feature_generic_EXPORTS)
#define SOTFEATUREGENERIC_EXPORT __declspec(dllexport)
#else
#define SOTFEATUREGENERIC_EXPORT __declspec(dllimport)
#endif
#else
#define SOTFEATUREGENERIC_EXPORT
#endif

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

namespace dynamicgraph {
namespace sot {

class SOTFEATUREGENERIC_EXPORT FeatureGeneric
    : public FeatureAbstract,
      FeatureReferenceHelper<FeatureGeneric> {
 public:
  static const std::string CLASS_NAME;
  virtual const std::string &getClassName(void) const { return CLASS_NAME; }

 protected:
  dynamicgraph::Vector::Index dimensionDefault;

  /* --- SIGNALS ------------------------------------------------------------ */
 public:
  dynamicgraph::SignalPtr<dynamicgraph::Vector, int> errorSIN;

  dynamicgraph::SignalPtr<dynamicgraph::Matrix, int> jacobianSIN;

  using FeatureAbstract::jacobianSOUT;

  using FeatureAbstract::errorSOUT;

 public:
  FeatureGeneric(const std::string &name);

  virtual ~FeatureGeneric(void) {}

  virtual unsigned int &getDimension(unsigned int &dim, int time);

  virtual dynamicgraph::Vector &computeError(dynamicgraph::Vector &res,
                                             int time);

  virtual dynamicgraph::Matrix &computeJacobian(dynamicgraph::Matrix &res,
                                                int time);

  virtual void display(std::ostream &os) const;

  DECLARE_REFERENCE_FUNCTIONS(FeatureGeneric);
};

} /* namespace sot */
} /* namespace dynamicgraph */

#endif  // #ifndef __SOT_FEATURE_GENERIC_HH__

/*
 * Local variables:
 * c-basic-offset: 2
 * End:
 */