mtsCollectorFactory.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Anton Deguet
  Created on: 2014-03-03

  (C) Copyright 2014 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---

*/

#ifndef _mtsCollectorFactory_h
#define _mtsCollectorFactory_h

#include <cisstMultiTask/mtsTaskFromSignal.h>

#include <string>
#include <list>
#include <map>

// Always include last
#include <cisstMultiTask/mtsExport.h>

class CISST_EXPORT mtsCollectorFactory: public mtsTaskFromSignal
{
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
 public:
    mtsCollectorFactory(const std::string & componentName);
    inline ~mtsCollectorFactory() {};

    void Configure(const std::string & configuration);
    void Run(void);
    void Cleanup(void);

    void AddSignal(const std::string & component,
                   const std::string & table,
                   const std::string & signal);

    void SetSampling(const std::string & component,
                     const std::string & table,
                     const int sampling);

    void Connect(void) const;

    void GetCollectorsNames(std::list<std::string> & collectors) const;

 protected:
    typedef std::pair<std::string, std::string> CollectorId; // component, state table
    typedef std::list<std::string> Signals; // list of signals
    typedef std::pair<std::string, Signals> CollectorData; // name of collector, signals
    typedef std::pair<CollectorId, CollectorData > Collector; // element type for the map of collectors
    typedef std::map<CollectorId, CollectorData > CollectorsType; // map of collectors
    CollectorsType mCollectors;

    void AddStateCollector(const std::string & component,
                           const std::string & table);
};

CMN_DECLARE_SERVICES_INSTANTIATION(mtsCollectorFactory)

#endif // _mtsCollectorFactory_h