openfluid::base::ExamplesManager Class Reference

#include <base/ExamplesManager.hpp>

Public Member Functions
	ExamplesManager ()=delete
	~ExamplesManager ()=delete

Static Public Member Functions
static bool	installProject (const std::string &ProjectDir, const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installSimulator (const std::string &SimulatorDir, const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installObserver (const std::string &ObserverDir, const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installAllProjects (const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installAllSimulators (const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installAllObservers (const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installAllWares (const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)
static bool	installAll (const std::string &ResourcesPath="", const std::string &InstallPath="", const bool Force=false)

Constructor & Destructor Documentation

ExamplesManager()

openfluid::base::ExamplesManager::ExamplesManager ( )

delete

~ExamplesManager()

openfluid::base::ExamplesManager::~ExamplesManager ( )

delete

Member Function Documentation

installAll()

static bool openfluid::base::ExamplesManager::installAll ( const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs all example projects and simulators

Parameters

[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installAllObservers()

static bool openfluid::base::ExamplesManager::installAllObservers ( const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs all example observers

Parameters

[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installAllProjects()

static bool openfluid::base::ExamplesManager::installAllProjects ( const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs all example projects

Parameters

[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installAllSimulators()

static bool openfluid::base::ExamplesManager::installAllSimulators ( const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs all example simulators

Parameters

[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installAllWares()

static bool openfluid::base::ExamplesManager::installAllWares ( const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs all example wares (simulators and observers)

Parameters

[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installObserver()

static bool openfluid::base::ExamplesManager::installObserver ( const std::string &  ObserverDir, const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

installProject()

static bool openfluid::base::ExamplesManager::installProject ( const std::string &  ProjectDir, const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs a single example project, using its directory name

Parameters

[in]	ProjectDir	Name of the project directory to install
[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

installSimulator()

static bool openfluid::base::ExamplesManager::installSimulator ( const std::string &  SimulatorDir, const std::string &  ResourcesPath = "", const std::string &  InstallPath = "", const bool  Force = false  )

static

Installs a single example simulator, using its directory name

Parameters

[in]	SimulatorDir	Name of the simulator directory to install
[in]	ResourcesPath	Path to the examples ressources, uses standard ressources path if empty (default is empty)
[in]	InstallPath	Path where to install the examples ressources, uses user openfluid path if empty (default is empty)
[in]	Force	If true, the installation is forced even if it already exists (default is false)

---

The documentation for this class was generated from the following file:

• base/ExamplesManager.hpp