Beliefstate.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 __BELIEFSTATE_H__
#define __BELIEFSTATE_H__


// System
#include <iostream>
#include <cstdlib>
#include <list>
#include <string>
#include <libconfig.h++>
#include <mutex>

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


namespace beliefstate {
  class Beliefstate : public UtilityBase {
  private:
    PluginSystem* m_psPlugins;
    bool m_bRun;
    int m_argc;
    char** m_argv;
    std::list<std::string> m_lstPluginsToLoad;
    std::list<Event> m_lstGlobalEvents;
    std::string m_strWorkspaceDirectory;
    std::mutex m_mtxTerminalResize;
    bool m_bTerminalWindowResize;
    bool m_bCommandLineOutput;
    bool m_bOnlyDisplayImportant;
    std::string m_strVersion;
    
  protected:
    std::list<std::string> m_lstConfigFileLocations;
    
  public:
    Beliefstate(int argc, char** argv);
    ~Beliefstate();
    
    std::string version();
    
    Result init(std::string strConfigFile = "");
    
    Result deinit();
    
    bool loadConfigFile(std::string strConfigFile);
    
    bool loadIndividualPluginConfigurationBranch(libconfig::Setting &sBranch, CKeyValuePair* ckvpInto, std::string strConfigPath = "", bool bIgnorePluginField = false);
    
    bool spreadEvent(Event evEvent);
    
    void spreadServiceEvent(ServiceEvent seServiceEvent);
    
    bool cycle();
    
    void triggerShutdown();
    
    void triggerTerminalResize();
    
    void setBaseDataDirectory(std::string strBaseDataDirectory);
    std::string baseDataDirectory();
    std::string resolveDirectoryTokens(std::string strPath);
    
    virtual std::string workspaceDirectory();
    
    std::string homeDirectory();
    
    virtual std::string findTokenReplacement(std::string strToken);
    bool handleUnhandledEvent(Event evEvent);
    
    std::string findPrefixPath(std::string strPathList, std::string strMatchingSuffix, std::string strDelimiter = ":");
  };
}


#endif /* __BELIEFSTATE_H__ */