ExamplesBuddy.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/


/**
  @file ExamplesBuddy.hpp

  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
 */


#ifndef __OPENFLUID_BUDDIES_EXAMPLESBUDDY_HPP__
#define __OPENFLUID_BUDDIES_EXAMPLESBUDDY_HPP__


#include <openfluid/dllexport.hpp>
#include <openfluid/buddies/OpenFLUIDBuddy.hpp>


namespace openfluid { namespace buddies {


class OPENFLUID_API ExamplesBuddy : public OpenFLUIDBuddy
{
  public:

    ExamplesBuddy(openfluid::buddies::BuddiesListener* Listener);

    ~ExamplesBuddy();

    bool run();

    bool installExampleFolder(const std::string& SourcePath, const std::string& InstallPath,
                                              const std::string& FolderName, const bool Force = false);
                                              
    bool installExampleProject(const std::string& ProjectsSourcePath, const std::string& ProjectsInstallPath,
                                              const std::string& ProjectDir, const bool Force = false);
                                 
    bool installExampleSimulator(const std::string& SimulatorSourcePath, const std::string& SimulatorInstallPath,
                                              const std::string& SimulatorDir, const bool Force = false);

    bool installAllExamplesFolders(const std::string& ExamplesSourcePath,
                                                   const std::string& ExamplesInstallPath, const bool Force = false);
};


} } // namespaces


#endif /* __OPENFLUID_BUDDIES_EXAMPLESBUDDY_HPP__ */