Documentation for OpenFLUID 2.2.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
openfluid::waresdev::WareSrcEnquirer Class Reference

#include <waresdev/WareSrcEnquirer.hpp>

Classes

struct  WarePathInfo
 

Static Public Member Functions

static std::string findWarePath (openfluid::ware::WareType WareType, const std::string &WareDirName)
 
static WarePathInfo getWareInfoFromPath (const std::string &Path)
 

Member Function Documentation

◆ findWarePath()

static std::string openfluid::waresdev::WareSrcEnquirer::findWarePath ( openfluid::ware::WareType  WareType,
const std::string &  WareDirName 
)
static

Try to detect full ware sources path using its type and its supposed directory name. It searches first in the current workspace then in the user examples

Parameters
[in]WareTypethe type of the ware to find
[in]WareDirNamethe expected directory name for the ware
Returns
the full path of the found ware sources, empty if not found

◆ getWareInfoFromPath()

static WarePathInfo openfluid::waresdev::WareSrcEnquirer::getWareInfoFromPath ( const std::string &  Path)
static

Returns information about the wares sources located at the given path.

Parameters
[in]Paththe path to the ware to inspect
Returns
the information about the ware

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