ito::ApiFunctions Class Reference

Static Public Member Functions
static ito::RetVal	mfilterGetFunc (const QString &name, ito::AddInAlgo::FilterDef *&FilterDef)
	function called by apiFilterGetFunc
static ito::RetVal	mfilterCall (const QString &name, QVector< ito::ParamBase > *paramsMand, QVector< ito::ParamBase > *paramsOpt, QVector< ito::ParamBase > *paramsOut)
	function called by apiFilterCall
static ito::RetVal	mfilterCallExt (const QString &name, QVector< ito::ParamBase > *paramsMand, QVector< ito::ParamBase > *paramsOpt, QVector< ito::ParamBase > *paramsOut, QSharedPointer< ito::FunctionCancellationAndObserver > observer)
	function called by apiFilterCallExt
static ito::RetVal	mfilterParamBase (const QString &name, QVector< ito::ParamBase > *paramsMand, QVector< ito::ParamBase > *paramsOpt, QVector< ito::ParamBase > *paramsOut)
	function called by apiFilterParamBase
static ito::RetVal	mfilterParam (const QString &name, QVector< ito::Param > *paramsMand, QVector< ito::Param > *paramsOpt, QVector< ito::Param > *paramsOut)
	function called by apiFilterParam
static ito::RetVal	mfilterVersion (const QString &name, int &version)
	function called by apiFilterVersion
static ito::RetVal	mfilterAuthor (const QString &name, QString &author)
	function called by apiFilterAuthor
static ito::RetVal	mfilterPluginName (const QString &name, QString &pluginName)
	function called by apiFilterPluginName
static ito::RetVal	maddInGetInitParams (const QString &name, const int pluginType, int *pluginNum, QVector< ito::Param > *&paramsMand, QVector< ito::Param > *&paramsOpt)
	function called by apiAddInGetInitParams
static ito::RetVal	maddInOpenActuator (const QString &name, const int pluginNum, const bool autoLoadParams, QVector< ito::ParamBase > *paramsMand, QVector< ito::ParamBase > *paramsOpt, ito::AddInActuator *&instance)
	function called by apiAddInOpenActuator
static ito::RetVal	maddInOpenDataIO (const QString &name, const int pluginNum, const bool autoLoadParams, QVector< ito::ParamBase > *paramsMand, QVector< ito::ParamBase > *paramsOpt, ito::AddInDataIO *&instance)
	function called by apiAddInOpenDataIO
static ito::RetVal	maddInClose (ito::AddInBase *instance)
	function called by apiAddInClose
static ito::DataObject *	mcreateFromDataObject (const ito::DataObject *dObj, int nrDims, ito::tDataType type, int *sizeLimits=NULL, ito::RetVal *retval=NULL)
	function called by apiCreateFromDataObject
static ito::DataObject *	mcreateFromNamedDataObject (const ito::DataObject *dObj, int nrDims, ito::tDataType type, const char *name=NULL, int *sizeLimits=NULL, ito::RetVal *retval=NULL)
	function called by apiCreateFromNamedDataObject
static QString	getCurrentWorkingDir (void)
	function called by apiGetCurrentWorkingDir
static ito::RetVal	mshowConfigurationDialog (ito::AddInBase *plugin, ito::AbstractAddInConfigDialog *configDialogInstance)
	function called by apiShowConfigurationDialog
static ito::RetVal	removed (...)
	function called by apiSendParamToPyWorkspace
static QString	getSettingsFile (void)
	get itom settings file
static ito::RetVal	setSettingsFile (QString settingsFile)
	setter function only used on AddInManager startup

Private Attributes
int	m_loadFPointer

Static Private Attributes
static QString	m_settingsFile

Member Function Documentation

getCurrentWorkingDir()

QString ito::ApiFunctions::getCurrentWorkingDir ( void )

static

function called by apiGetCurrentWorkingDir

Helper function returning the currently selected directory of the filesystemwidget

Parameters

[in,out]

dir

the currently selected directory

Returns

retOk on success, retError otherwise

The function checks if the types of the passed python parameter and the parameter are compatible and sets the parameter value if it is possible. If the parameter cannot be set an error is returned.

removed()

ito::RetVal ito::ApiFunctions::removed ( ... )

static

function called by apiSendParamToPyWorkspace

function called by apiSendParamsToPyWorkspace substitute for removed functions

---

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

• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/AddInManager/apiFunctions.h
• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/AddInManager/apiFunctions.cpp