openfluid::waresdev Namespace Reference

Classes
class	BuilderextSignatureSerializer
class	ObserverSignatureSerializer
class	SimulatorSignatureSerializer
class	SimulatorSignatureXMLReader
struct	WareBuildOptions
struct	CppWriter
struct	DataJsonConverter
class	WareSignatureSerializer
class	WareSrcChecker
class	WareSrcContainer
class	WareSrcContainerOps
class	WareSrcDocalyzer
class	WareSrcDocalyzerListener
class	WareSrcEnquirer
class	WareSrcFactory
class	WarePurgeHandler
class	WareSrcMigrator
class	WareSrcMigratorListener
class	WareSrcOpsListener

Functions
std::string OPENFLUID_API	getGhostSimulatorPath (const std::string &ParentPath, const openfluid::ware::WareID_t &ID)
openfluid::tools::Path OPENFLUID_API	oldSignaturePath (const std::string &ParentPath, const openfluid::ware::WareID_t &ID)
bool OPENFLUID_API	migrateGhostSimulator (const std::string &ParentPath, const openfluid::ware::WareID_t &ID)
openfluid::ware::WareType	detectWareTypeFromJson (const openfluid::thirdparty::json &Json)
openfluid::ware::WareType	detectWareType (const std::string &Path)
std::pair< openfluid::ware::WareType, openfluid::ware::WareID_t >	detectWareTypeAndID (const std::string &Path)
bool OPENFLUID_API	IsCppFile (const openfluid::tools::FilesystemPath &FileObj)
bool OPENFLUID_API	IsCMakeFile (const openfluid::tools::FilesystemPath &FileObj)
bool OPENFLUID_API	hasUserAccess (const std::string &UserName, bool IsLoggedIn, const std::set< std::string > &ROUsers, const std::set< std::string > &RWUsers={})
bool OPENFLUID_API	isWareInCurrentWorkspace (const std::string &WarePath)
std::map< std::string, std::string > OPENFLUID_API	initializeConfigureVariables ()
int OPENFLUID_API	cloneWare (const std::string &SourceURL, const std::string &SourceType="hub", const std::string &ParentPath=".", const std::string &WareID="", const std::string &WareType="")

Variables
const std::string	BUILD_ONLY_MODE_STRING
const std::string	BUILD_INSTALL_MODE_STRING
const std::string	DEBUG_CONFIG_MODE_STRING
const std::string	RELEASE_CONFIG_MODE_STRING
static const std::vector< std::string >	CppFilesExt

Function Documentation

cloneWare()

int OPENFLUID_API openfluid::waresdev::cloneWare	(	const std::string &	SourceURL,
		const std::string &	SourceType = "hub",
		const std::string &	ParentPath = ".",
		const std::string &	WareID = "",
		const std::string &	WareType = ""
	)

Clones a ware from remote git or hub URL

Parameters

[in]	SourceURL	the ware path, the hub or git adress, may be optional
[in]	SourceType	either "hub" or "git" depending on source type
[in]	ParentPath	the path where clone will be run
[in]	WareID	the ware path, used for both local name and remote search on hub
[in]	WareType	the ware type, required for hub clone

Returns

exitcode of clone operation (0 means success)

detectWareType()

openfluid::ware::WareType openfluid::waresdev::detectWareType ( const std::string &  Path )

inline

detectWareTypeAndID()

std::pair<openfluid::ware::WareType,openfluid::ware::WareID_t> openfluid::waresdev::detectWareTypeAndID ( const std::string &  Path )

inline

detectWareTypeFromJson()

openfluid::ware::WareType openfluid::waresdev::detectWareTypeFromJson ( const openfluid::thirdparty::json &  Json )

inline

getGhostSimulatorPath()

std::string OPENFLUID_API openfluid::waresdev::getGhostSimulatorPath	(	const std::string &	ParentPath,
		const openfluid::ware::WareID_t &	ID
	)

hasUserAccess()

bool OPENFLUID_API openfluid::waresdev::hasUserAccess	(	const std::string &	UserName,
		bool	IsLoggedIn,
		const std::set< std::string > &	ROUsers,
		const std::set< std::string > &	RWUsers = {}
	)

Checks if a given user can do read operations on a ware based on the RO/RW lists

Parameters

[in]	UserName	the current user to check
[in]	IsLoggedIn	true if logged in to hub
[in]	ROUsers	the set of users with read only access
[in]	RWUsers	the set of users with read+write access

Returns

true if user is allowed to access the corresponding ware

initializeConfigureVariables()

std::map<std::string,std::string> OPENFLUID_API openfluid::waresdev::initializeConfigureVariables

(

)

Initializes a map of CMake variables according to the OpenFLUID installation context

Returns

a map of variables

IsCMakeFile()

bool OPENFLUID_API openfluid::waresdev::IsCMakeFile

(

const openfluid::tools::FilesystemPath &

FileObj

)

Returns true if the given file path is a CMake file (based on its name and/or extension)

Parameters

[in]

FileObj

The file path

Returns

true if the file a CMake file

IsCppFile()

bool OPENFLUID_API openfluid::waresdev::IsCppFile

(

const openfluid::tools::FilesystemPath &

FileObj

)

Returns true if the given file path is a C++ source file (based on its extension)

Parameters

[in]

FileObj

The file path

Returns

true if the file extension is a C++ extension

isWareInCurrentWorkspace()

bool OPENFLUID_API openfluid::waresdev::isWareInCurrentWorkspace

(

const std::string &

WarePath

)

Checks if a given ware id is found in current workspace. Wrapper of WareSrcEnquirer function

Parameters

[in]

WarePath

the ware path

Returns

true if ware found in workspace

migrateGhostSimulator()

bool OPENFLUID_API openfluid::waresdev::migrateGhostSimulator	(	const std::string &	ParentPath,
		const openfluid::ware::WareID_t &	ID
	)

oldSignaturePath()

openfluid::tools::Path OPENFLUID_API openfluid::waresdev::oldSignaturePath	(	const std::string &	ParentPath,
		const openfluid::ware::WareID_t &	ID
	)

Variable Documentation

BUILD_INSTALL_MODE_STRING

const std::string openfluid::waresdev::BUILD_INSTALL_MODE_STRING

BUILD_ONLY_MODE_STRING

const std::string openfluid::waresdev::BUILD_ONLY_MODE_STRING

CppFilesExt

const std::vector<std::string> openfluid::waresdev::CppFilesExt

inlinestatic

DEBUG_CONFIG_MODE_STRING

const std::string openfluid::waresdev::DEBUG_CONFIG_MODE_STRING

RELEASE_CONFIG_MODE_STRING

const std::string openfluid::waresdev::RELEASE_CONFIG_MODE_STRING