parfis.h File Reference

Main declarations for Parfis objects. More...

#include <string>
#include <vector>
#include <map>
#include <memory>
#include "datastruct.h"

Go to the source code of this file.

Classes
struct	parfis::Parfis
	The main class in the parfis library. More...

Namespaces
	parfis
	Main namespace of the library.
	parfis::api
	Exported C functions.

Macros
#define	DECL_EXPORT   __attribute__((visibility("default")))
	Export macro.
#define	DECL_IMPORT   __attribute__((visibility("default")))
	Import macro.
#define	PARFIS_EXPORT   DECL_IMPORT
	Export/import macro reconfiguration if compiling/calling the library.

Functions
const PARFIS_EXPORT char *	parfis::api::info ()
	Returns info about the program settings. More...
const PARFIS_EXPORT char *	parfis::api::parfisInfo (uint32_t id)
	Returns info about the Parfis object. More...
const PARFIS_EXPORT char *	parfis::api::getLogFileName (uint32_t id)
	Gets the name of the log file as a const char*. More...
const PARFIS_EXPORT char *	parfis::api::getLogStr (uint32_t id)
	Returns the current log string from the Parfis object. More...
const PARFIS_EXPORT char *	parfis::api::version ()
	Returns version string. More...
PARFIS_EXPORT uint32_t	parfis::api::newParfis (const char *cfgStr="", uint32_t writeLogFile=0)
	Creates new Parfis object and returns its id. More...
PARFIS_EXPORT int	parfis::api::setConfig (uint32_t id, const char *str)
	Configures the Parfis object with the given id. More...
PARFIS_EXPORT int	parfis::api::setConfigFromFile (uint32_t id, const char *str)
	Configures the Parfis object with the given id from a file. More...
PARFIS_EXPORT int	parfis::api::loadCfgData (uint32_t id)
	Wrapper for calling member function with the same name from the Parfis object. More...
PARFIS_EXPORT int	parfis::api::loadSimData (uint32_t id)
PARFIS_EXPORT int	parfis::api::setPyCfgData (uint32_t id)
	Loads the PyCfgData. More...
PARFIS_EXPORT int	parfis::api::setPySimData (uint32_t id)
	Loads the PySimData. More...
const PARFIS_EXPORT char *	parfis::api::defaultConfiguration ()
	Returns the default configuration hardcoded in DEFAULT_INITIALIZATION_STRING. More...
const PARFIS_EXPORT char *	parfis::api::getConfig (uint32_t id)
	Returns configuration of Parfis object. More...
const PARFIS_EXPORT char *	parfis::api::getConfigParam (uint32_t id, const char *key)
	Returns value for a single configuration parameter of Parfis object. More...
const PARFIS_EXPORT CfgData *	parfis::api::getCfgData (uint32_t id)
	Returns pointer to the CfgData of the Parfis object given by id. More...
const PARFIS_EXPORT PyCfgData *	parfis::api::getPyCfgData (uint32_t id)
	Returns pointer to the PyCfgData of the Parfis object given by id. More...
const PARFIS_EXPORT SimData *	parfis::api::getSimData (uint32_t id)
	Returns pointer to the SimData of the Parfis object given by id. More...
const PARFIS_EXPORT PySimData *	parfis::api::getPySimData (uint32_t id)
	Returns pointer to the PySimData of the Parfis object given by id. More...
PARFIS_EXPORT int	parfis::api::deleteParfis (uint32_t id)
	Deletes the Parfis object given by the id. More...
PARFIS_EXPORT int	parfis::api::deleteAll ()
	Deletes all Parfis objects. More...
const PARFIS_EXPORT std::vector< uint32_t > &	parfis::api::getParfisIdVec ()
	Get the Parfis vector of ids from s_parfisMap. More...
PARFIS_EXPORT int	parfis::api::runCommandChain (uint32_t id, const char *key)
	Run command chain given by id an name of the command chain. More...
const PARFIS_EXPORT char *	parfis::api::toStringDouble (double num)
	Expose the custom Global::to_string conversion from double. More...
const PARFIS_EXPORT char *	parfis::api::toStringFloat (float num)
	Expose the custom Global::to_string conversion from float. More...

Detailed Description

Main declarations for Parfis objects.