The itom plot and figure API contains a bunch of functions that can be called by the core application itom as well as by every designer plugin. More...

Macros
#define	apiPaletteGetNumberOfColorBars ((ito::RetVal ()(int &number)) ito::ITOM_API_FUNCS_GRAPH[0])

#define	apiPaletteGetColorBarName ((ito::RetVal ()(const QString &name, ito::ItomPalette &palette)) ito::ITOM_API_FUNCS_GRAPH[1])

#define	apiPaletteGetColorBarIdx ((ito::RetVal ()(const int index, ito::ItomPalette &palette)) ito::ITOM_API_FUNCS_GRAPH[2])

#define	apiGetFigure ((ito::RetVal ()(const QString &figCategoryName, const QString &figClassName, ito::uint32 &UID, QWidget *figure, QWidget parent)) ito::ITOM_API_FUNCS_GRAPH[3])

#define	apiGetPluginList ((ito::RetVal ()(const ito::pluginInfo requirements, QHash<QString, ito::pluginInfo> &pluginList, const QString preference)) ito::ITOM_API_FUNCS_GRAPH[4])

#define	apiStartLiveData ((ito::RetVal ()(QObject liveDataSource, QObject liveDataView)) ito::ITOM_API_FUNCS_GRAPH[5])

#define	apiStopLiveData ((ito::RetVal ()(QObject liveDataSource, QObject liveDataView)) ito::ITOM_API_FUNCS_GRAPH[6])

#define	apiConnectLiveData ((ito::RetVal ()(QObject liveDataSource, QObject liveDataView)) ito::ITOM_API_FUNCS_GRAPH[7])

#define	apiDisconnectLiveData ((ito::RetVal ()(QObject liveDataSource, QObject liveDataView)) ito::ITOM_API_FUNCS_GRAPH[8])

#define	apiPaletteGetColorBarIdxFromName ((ito::RetVal ()(const QString &name, ito::int32 &index)) ito::ITOM_API_FUNCS_GRAPH[9])

#define	apiGetFigureSetting ((QVariant ()(const QObject figureClass, const QString &key, const QVariant &defaultValue, ito::RetVal retval)) ito::ITOM_API_FUNCS_GRAPH[10])

#define	apiGetPluginWidget ((ito::RetVal ()(void , QVector<ito::ParamBase> paramsMand, QVector<ito::ParamBase> paramsOpt, QPointer<QWidget>widget)) ito::ITOM_API_FUNCS_GRAPH[11])

#define	apiGetFigureIDbyHandle ((ito::RetVal ()(QObject *figure, ito::uint32 &figureUID)) ito::ITOM_API_FUNCS_GRAPH[12])

#define	apiGetItomPlotHandleByID ((ito::RetVal ()(const ito::uint32 &figureUID, ito::ItomPlotHandle &plotHandle)) ito::ITOM_API_FUNCS_GRAPH[13])

#define	apiSendParamToPyWorkspace (* (ito::RetVal (*)(const QString &varname, const QSharedPointer<ito::ParamBase> &value)) ito::ITOM_API_FUNCS_GRAPH[14])
	sends the given ParamBase value to the global python workspace More...

#define	apiSendParamsToPyWorkspace (* (ito::RetVal (*)(const QStringList &varnames, const QVector<QSharedPointer<ito::ParamBase> > &values)) ito::ITOM_API_FUNCS_GRAPH[15])
	sends the given ParamBase value to the global python workspace More...

#define	apiQObjectPropertyRead (* (ito::RetVal ()(const QObject object, const char* propName, QVariant &value)) ito::ITOM_API_FUNCS_GRAPH[16])
	read a property from an QObject based instance. More...

#define	apiQObjectPropertyWrite (* (ito::RetVal ()(QObject object, const char* propName, const QVariant &value)) ito::ITOM_API_FUNCS_GRAPH[17])
	write a property to an QObject based instance. More...

Detailed Description

The itom plot and figure API contains a bunch of functions that can be called by the core application itom as well as by every designer plugin.

Every function is given by a certain preprocessor definition that describes the return value, parameters and function name of the method to call. Each preprocessor definition is redirected to a function pointer that becomes valid at runtime. The initialization of these function pointers in any plugins is an automatic process by itom, called when loading the plugin.

How to read the following definitions?

Basically the first word after the #define word is the method to call. After the first star the return value follows (the star into brackets is not part of the return value). Then there is a list of different parameters for this method.

Macro Definition Documentation

#define apiQObjectPropertyRead (* (ito::RetVal (*)(const QObject *object, const char* propName, QVariant &value)) ito::ITOM_API_FUNCS_GRAPH[16])

read a property from an QObject based instance.

Parameters

object is the object is the name of the property is a reference to the obtained value

Returns: ito::retOk if property could be found and read, else ito::retError

#define apiQObjectPropertyWrite (* (ito::RetVal (*)(QObject *object, const char* propName, const QVariant &value)) ito::ITOM_API_FUNCS_GRAPH[17])

write a property to an QObject based instance.

Parameters

object is the object is the name of the property is the value to set

Returns: ito::retOk if property could be found and written, else ito::retError

#define apiSendParamsToPyWorkspace (* (ito::RetVal (*)(const QStringList &varnames, const QVector<QSharedPointer<ito::ParamBase> > &values)) ito::ITOM_API_FUNCS_GRAPH[15])

sends the given ParamBase value to the global python workspace

This methods sends the given ParamBase values to the global python workspace using the indicated variable names. Existing values with the same name will be overwritten, unless they cover functions, methods, classes or types.

Invalid variable names will also result in an error.

Parameters

varnames	are the variable name (must be valid python variable names)
values	are the ParamBase values

Returns: ito::retOk on success, else ito::retError

#define apiSendParamToPyWorkspace (* (ito::RetVal (*)(const QString &varname, const QSharedPointer<ito::ParamBase> &value)) ito::ITOM_API_FUNCS_GRAPH[14])

sends the given ParamBase value to the global python workspace

This methods sends the given ParamBase value to the global python workspace using the indicated variable name. Existing values with the same name will be overwritten, unless they cover functions, methods, classes or types.

Invalid variable name will also result in an error.

Parameters

varname	is the variable name (must be a valid python variable name)
value	is the ParamBase value

Returns: ito::retOk on success, else ito::retError

Macros

Detailed Description

Macro Definition Documentation