fwConfigs
|
Files | |
file | fwDpFunction.ctl |
Configuration object indexes | |
Used to access the configuration object attributes (object of type dyn_anytype). | |
const int | fwDpFunction_OBJ_FUNCTION = 5 |
const int | fwDpFunction_OBJ_PARAM = 6 |
const int | fwDpFunction_OBJ_GLOBAL = 7 |
const int | fwDpFunction_OBJ_TYPE = 8 |
const int | fwDpFunction_OBJ_STAT_TYPE = 9 |
const int | fwDpFunction_OBJ_STAT_INTERVAL = 10 |
const int | fwDpFunction_OBJ_STAT_DELAY = 11 |
const int | fwDpFunction_OBJ_STAT_READ_ARCHIVE = 12 |
Utility functions | |
Used to access the configuration object attributes (object of type dyn_anytype). | |
fwDpFunction_objectInitialize (dyn_mixed &functionObject) | |
int | fwDpFunction_objectExtractType (dyn_mixed functionObject) |
Set/Get functions | |
Used to set/get the dp function settings to/from the dpe. The settings are stored into the settings object. | |
fwDpFunction_deleteMultiple (dyn_string dpes, dyn_string &exceptionInfo) | |
fwDpFunction_deleteMany (dyn_string dpes, dyn_string &exceptionInfo) | |
fwDpFunction_delete (string dpe, dyn_string &exceptionInfo) | |
fwDpFunction_objectSet (string dpe, dyn_mixed functionObject, dyn_string &exceptionInfo, bool runChecks=TRUE) | |
fwDpFunction_objectSetMany (dyn_string &dpes, dyn_mixed &functionObjects, dyn_string &exceptionInfo, bool runChecks=TRUE) | |
fwDpFunction_objectGet (string dpe, bool &configExists, dyn_mixed &functionObject, dyn_string &exceptionInfo) | |
fwDpFunction_objectGetMany (dyn_string &dpes, dyn_bool &configExists, dyn_mixed &functionObjects, dyn_string &exceptionInfo) | |
This is a list of variables and functions used by both fwDpFunction DPE Connection and fwDpFunction Statistical
fwDpFunction_delete | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Deletes the DP function config for the given data point element
dpe | data point element |
exceptionInfo | details of any errors are returned here |
fwDpFunction_deleteMany | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
Deletes the DP function config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwDpFunction_deleteMultiple | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
/**Deletes the DP function config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
int fwDpFunction_objectExtractType | ( | dyn_mixed | functionObject | ) |
Return the type of dp function stored in the dp function object.
functionObject | This object containing the dp function parameters. |
References fwDpFunction_OBJ_TYPE.
fwDpFunction_objectGet | ( | string | dpe, |
bool & | configExists, | ||
dyn_mixed & | functionObject, | ||
dyn_string & | exceptionInfo | ||
) |
Get the dp function settings from a single dpe
dpe | dpe from which to extract dpFunction. |
configExists | True if dp config exists, false if dp config does not exist |
functionObject | Function parameter object to be returend. |
exceptionInfo | Details of any exceptions are returned here |
fwDpFunction_objectGetMany | ( | dyn_string & | dpes, |
dyn_bool & | configExists, | ||
dyn_mixed & | functionObjects, | ||
dyn_string & | exceptionInfo | ||
) |
Get the dp function settings from a list of dpes
dpes | List of dpes from which to extract the dpFunction. Passed as reference only for performance reasons. Not modified. |
configExists | True if dp config exists, false if dp config does not exist |
functionObjects | List of function parameter objects to be returend. |
exceptionInfo | Details of any exceptions are returned here |
fwDpFunction_objectInitialize | ( | dyn_mixed & | functionObject | ) |
Initialize the dp function object with default parameters. This function is not needed if using the functions fwDpFunction_objectCreateStatistical() or fwDpFunction_objectCreateDpeConnection(). By default, the object is initialized as no dp function.
functionObject | This object will contain the dp function parameters with default values. |
References fwDpFunction_OBJ_FUNCTION, fwDpFunction_OBJ_GLOBAL, fwDpFunction_OBJ_PARAM, fwDpFunction_OBJ_STAT_DELAY, fwDpFunction_OBJ_STAT_INTERVAL, fwDpFunction_OBJ_STAT_READ_ARCHIVE, fwDpFunction_OBJ_STAT_TYPE, and fwDpFunction_OBJ_TYPE.
Referenced by fwDpFunction_objectCreateDpeConnection(), fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractDpeConnection(), and fwDpFunction_objectExtractStatistical().
fwDpFunction_objectSet | ( | string | dpe, |
dyn_mixed | functionObject, | ||
dyn_string & | exceptionInfo, | ||
bool | runChecks = TRUE |
||
) |
Set the dp-function object to the dpe
dpe | dpe to be configured with dpFunction. |
functionObject | This object contains the dp function parameters. |
exceptionInfo | Details of any exceptions are returned here |
runChecks | Optional parameter - default TRUE TRUE: Run consistency checks on the input to the function (HIGHLY RECOMMENDED) FALSE: Do not run any checks at all - can result in badly configured or non configured dp functions. Use only for performance reasons. |
fwDpFunction_objectSetMany | ( | dyn_string & | dpes, |
dyn_mixed & | functionObjects, | ||
dyn_string & | exceptionInfo, | ||
bool | runChecks = TRUE |
||
) |
Set the dp-function object to the dpes
dpes | List of dpes to be configured with dpFunction. |
functionObjects | List of function parameter objects. Each of this object contains the dp function parameters. The list lenght must be the same length as dpes. Nevertheless, if the length is 1 (i.e. only one configuration), the same configuration is applied to all the dpes. Passed as reference only for performance reasons. Not modified. |
exceptionInfo | Details of any exceptions are returned here |
runChecks | Optional parameter - default TRUE TRUE: Run consistency checks on the input to the function (HIGHLY RECOMMENDED) FALSE: Do not run any checks at all - can result in badly configured or non configured dp functions. Use only for performance reasons. |
const int fwDpFunction_OBJ_FUNCTION = 5 |
Referenced by fwDpFunction_objectCreateDpeConnection(), fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractDpeConnection(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_GLOBAL = 7 |
Referenced by fwDpFunction_objectCreateDpeConnection(), fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractDpeConnection(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_PARAM = 6 |
Compulsory. For Dpe Connection and Statistical. See use example on fwDpFunction_OBJ_objectSet().
Referenced by fwDpFunction_objectCreateDpeConnection(), fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractDpeConnection(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_STAT_DELAY = 11 |
Referenced by fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_STAT_INTERVAL = 10 |
Referenced by fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_STAT_READ_ARCHIVE = 12 |
Referenced by fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_STAT_TYPE = 9 |
Referenced by fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractStatistical(), and fwDpFunction_objectInitialize().
const int fwDpFunction_OBJ_TYPE = 8 |
Referenced by fwDpFunction_objectCreateDpeConnection(), fwDpFunction_objectCreateStatistical(), fwDpFunction_objectExtractDpeConnection(), fwDpFunction_objectExtractStatistical(), fwDpFunction_objectExtractType(), fwDpFunction_objectInitialize(), fwDpFunction_objectIsDpeConnection(), and fwDpFunction_objectIsStatistical().