alextractor.h

Go to the documentation of this file.

#pragma once
#ifndef _LIBALEXTRACTOR_ALEXTRACTOR_ALEXTRACTOR_H_
#define _LIBALEXTRACTOR_ALEXTRACTOR_ALEXTRACTOR_H_

#include <alcommon/almodule.h>
#include <alextractor/config.h>

#include <boost/scoped_ptr.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/shared_mutex.hpp>

namespace AL
{
  class ALBroker;
  class ALExtractorPrivate;

  class ALEXTRACTOR_API ALExtractor: public ALModule
  {
  public:
    ALExtractor(boost::shared_ptr<ALBroker> pBroker,
                const std::string& pName);

    virtual ~ALExtractor();

    virtual void subscribe(const std::string &pSubscribedName,
                           const int &pPeriod,
                           const float &pPrecision);

    virtual void subscribe(const std::string &pSubscribedName);


    virtual void updatePeriod(const std::string &pSubscribedName,
                              const int &pPeriod);

    virtual void updatePrecision(const std::string &pSubscribedName,
                                 const float &pPrecision);

    virtual void unsubscribe(const std::string &pSubscribedName);

    virtual int getCurrentPeriod();

    virtual float getCurrentPrecision();

    virtual int getMyPeriod(const std::string &pSubscribedName);

    virtual float getMyPrecision(const std::string &pSubscribedName);

    ALValue getSubscribersInfo();

  protected:

    virtual void xStartDetection(const int pPeriod,
                                 const float pPrecision) = 0;

    virtual void xUpdateParameters(const int pPeriod, const float pPrecision) {}

    virtual void xStopDetection() = 0;


    virtual int getDefaultPeriod();

    virtual float getDefaultPrecision();


    virtual int getMinimumPeriod();

    virtual int getMaximumPeriod();

    virtual std::vector<std::string> getOutputNames(void);

    std::vector<std::string> getEventList(void);

    std::vector<std::string> getMemoryKeyList(void);

    void declareEvent(const std::string& event);

    void declareMemoryKey(const std::string& key);

  private:
    boost::scoped_ptr<ALExtractorPrivate> _private;
    void xUpdateParameters();


    boost::mutex fSubscriptionMutex;
  };
} // namespace AL

#endif  // _LIBALEXTRACTOR_ALEXTRACTOR_ALEXTRACTOR_H_