PluginInstance.h

Go to the documentation of this file.

/*********************************************************************
 * Software License Agreement (BSD License)
 *
 *  Copyright (c) 2013, Institute for Artificial Intelligence,
 *  Universität Bremen.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   * Neither the name of the Institute for Artificial Intelligence,
 *     Universität Bremen, nor the names of its contributors may be
 *     used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *********************************************************************/

#ifndef __PLUGIN_INSTANCE_H__
#define __PLUGIN_INSTANCE_H__


// System
#include <iostream>
#include <fstream>
#include <cstdlib>
#include <string>
#include <dlfcn.h>
#include <thread>

// Private
#include <Types.h>
#include <ForwardDeclarations.h>
#include <Plugin.h>
#include <UtilityBase.h>


namespace beliefstate {
  class PluginInstance : public UtilityBase {
  private:
    void* m_vdLibHandle;
    plugins::Plugin* m_piInstance;
    std::string m_strName;
    std::thread* m_thrdPluginCycle;
    bool m_bRunCycle;
    std::mutex m_mtxCycleResults;
    Result m_resCycleResult;
    
  public:
    PluginInstance();
    ~PluginInstance();
    
    Result loadPluginLibrary(std::string strFilepath);
    void unload();
    
    void setDevelopmentPlugin(bool bDevelopmentPlugin);
    bool developmentPlugin();
    
    int pluginID();
    
    Result init(int argc, char** argv);
    Result cycle();
    void spinCycle();
    std::list<std::string> dependencies();
    
    bool subscribedToEvent(std::string strEventName);
    void consumeEvent(Event evEvent);
    bool offersService(std::string strServiceName);
    Event consumeServiceEvent(ServiceEvent seServiceEvent);
    
    std::string name();
    
    Result currentResult();
    void setRunning(bool bRunCycle);
    void waitForJoin();
  };
}


#endif /* __PLUGIN_INSTANCE_H__ */