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-2023 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/mtsCollectorBase.h>
 
#include <string>
#include <list>
#include <map>
 
class mtsCollectorEvent;
class mtsCollectorBaseData;
class mtsCollectorStateData;
class mtsCollectorEventData;
 
// Always include last
#include <cisstMultiTask/mtsExport.h>

class CISST_EXPORT mtsCollectorFactory: public mtsCollectorBase
{
    CMN_DECLARE_SERVICES(CMN_NO_DYNAMIC_CREATION, CMN_LOG_ALLOW_DEFAULT);
 
    friend class mtsCollectorBaseData;
 
 public:
    mtsCollectorFactory(const std::string & componentName);
    inline ~mtsCollectorFactory() {};
 
    void Configure(const std::string & configuration) override;
    void Run(void) override;
    void Cleanup(void) override;

    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 AddEventWrite(const std::string & component_name,
                       const std::string & interface_name,
                       const std::string & event_name);
    void AddEventVoid(const std::string & component_name,
                      const std::string & interface_name,
                      const std::string & event_name);

    void AddAllEvents(const std::string & component_name,
                      const std::string & interface_name);

    void AddAllEvents(const std::string & component_name);

    bool Connect(void) override;

    void GetCollectorsNames(std::list<std::string> & collectors) const;
 
 protected:
    typedef std::pair<std::string, std::string> CollectorId; // component, state table
    std::map<CollectorId, mtsCollectorStateData *> mStateCollectors;
    void AddStateCollector(const std::string & component,
                           const std::string & table);
 
    std::map<std::string, mtsCollectorEventData *> mEventCollectors;
    mtsCollectorEvent * GetEventCollector(const std::string & component);
 
    std::list<mtsCollectorBaseData *> mAllCollectors;
 
    /* methods to mimic any collector */
    void StartCollection(const double & delayInSeconds) override;
    void StopCollection(const double & delayInSeconds) override;
    void SetWorkingDirectory(const std::string & directory) override;
    void SetOutputToDefault(void) override;
    void CollectionStartedEventHandler(const bool & started);
    void ProgressEventHandler(const size_t & counter);
};
 
CMN_DECLARE_SERVICES_INSTANTIATION(mtsCollectorFactory)
 
#endif // _mtsCollectorFactory_h