fwConfigs
8.4.0
|
Functions | |
fwSmoothing_setMany (dyn_string &dpes, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_string &exceptionInfo, bool runDriverCheck=FALSE, bool storeInParamHistory=TRUE) | |
fwSmoothing_setMultiple (dyn_string dpes, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool runDriverCheck=FALSE, bool storeInParamHistory=TRUE) | |
fwSmoothing_set (string dpe, int smoothProcedure, float deadband, float timeInterval, dyn_string &exceptionInfo, bool runDriverCheck=FALSE, bool storeInParamHistory=TRUE) | |
fwSmoothing_deleteMultiple (dyn_string dpes, dyn_string &exceptionInfo) | |
fwSmoothing_deleteMany (dyn_string dpes, dyn_string &exceptionInfo) | |
fwSmoothing_delete (string dpe, dyn_string &exceptionInfo) | |
fwSmoothing_get (string dpe, bool &configExists, int &smoothProcedure, float &deadband, float &timeInterval, dyn_string &exceptionInfo) | |
fwSmoothing_getManyWithCheck (dyn_string &dpes, dyn_bool &configExists, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_string &exceptionInfo) | |
fwSmoothing_getMany (dyn_string &dpes, dyn_bool &configExists, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_string &exceptionInfo) | |
_fwSmoothing_getParameters (dyn_string &dpes, bool isArchiveConfig, dyn_int &smoothProcedure, dyn_float &deadband, dyn_float &timeInterval, dyn_string &exceptionInfo, int groupNumber=1) | |
_fwSmoothing_setParameters (dyn_string dpes, bool isArchiveConfig, dyn_int smoothProcedure, dyn_float deadband, dyn_float timeInterval, dyn_string &exceptionInfo, bool storeInParamHistory=TRUE, dyn_int groupNumbers=makeDynInt()) | |
This library contains function associated with the smoothing config. Functions are provided for getting the current settings, deleting the config and setting the config
22/11/2013 Marco Boccioli, Alexey Merezhin
19/09/2011 Marco Boccioli
05/09/2011 Marco Boccioli
31/08/2011 Marco Boccioli
12/08/2011 Marco Boccioli
26/01/2011 Marco Boccioli
21/01/2004 Oliver
15/01/2004 Oliver
15/09/2000 Oliver
added error handling to save and delete functions
Oliver
fwSmoothing_setMany | ( | dyn_string & | dpes, |
dyn_int & | smoothProcedure, | ||
dyn_float & | deadband, | ||
dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | runDriverCheck = FALSE , |
||
bool | storeInParamHistory = TRUE |
||
) |
Adds or modifies the smoothing config on the given dpes
dpes | list of data point elements. Passed as reference only for performance reasons. Not modified. |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time. Passed as reference only for performance reasons. Not modified. |
deadband | deadband value . Passed as reference only for performance reasons. Not modified. |
timeInterval | time in seconds. Passed as reference only for performance reasons. Not modified. |
exceptionInfo | details of any errors are returned here |
runDriverCheck | Optional parameter (default value = FALSE) - TRUE to check if driver is running before setting config, else FALSE The necessary driver number must be running in order to successfully create config |
storeInParamHistory | Optional parameter (default value = TRUE) - TRUE to archive the parameter change, else FALSE |
fwSmoothing_setMultiple | ( | dyn_string | dpes, |
int | smoothProcedure, | ||
float | deadband, | ||
float | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | runDriverCheck = FALSE , |
||
bool | storeInParamHistory = TRUE |
||
) |
Adds or modifies the smoothing config on the given dpes
dpes | list of data point elements |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | deadband value |
timeInterval | time in seconds |
exceptionInfo | details of any errors are returned here |
runDriverCheck | Optional parameter (default value = FALSE) - TRUE to check if driver is running before setting config, else FALSE The necessary driver number must be running in order to successfully create config |
storeInParamHistory | Optional parameter (default value = TRUE) - TRUE to archive the parameter change, else FALSE |
fwSmoothing_set | ( | string | dpe, |
int | smoothProcedure, | ||
float | deadband, | ||
float | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | runDriverCheck = FALSE , |
||
bool | storeInParamHistory = TRUE |
||
) |
Adds or modifies the smoothing config on the given dpes
dpe | data point element |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | deadband value |
timeInterval | time in seconds |
exceptionInfo | details of any errors are returned here |
runDriverCheck | Optional parameter (default value = FALSE) - TRUE to check if driver is running before setting config, else FALSE |
storeInParamHistory | Optional parameter (default value = TRUE) - TRUE to archive the parameter change, else FALSE The necessary driver number must be running in order to successfully create config |
fwSmoothing_deleteMultiple | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
Deletes the smoothing config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwSmoothing_deleteMany | ( | dyn_string | dpes, |
dyn_string & | exceptionInfo | ||
) |
Deletes the smoothing config for the given data point elements
dpes | list of data point elements |
exceptionInfo | details of any errors are returned here |
fwSmoothing_delete | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Deletes the smoothing config for the given data point element
dpe | data point element |
exceptionInfo | details of any errors are returned here |
fwSmoothing_get | ( | string | dpe, |
bool & | configExists, | ||
int & | smoothProcedure, | ||
float & | deadband, | ||
float & | timeInterval, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the smoothing config from the given data point element.
The function checks that the relevant driver is running. If not it returns an exception saying the config could not be read.
dpe | data point element |
configExists | TRUE if smoothing config exists, else FALSE |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | Deadband value |
timeInterval | Time interval in seconds |
exceptionInfo | details of any errors are returned here |
fwSmoothing_getManyWithCheck | ( | dyn_string & | dpes, |
dyn_bool & | configExists, | ||
dyn_int & | smoothProcedure, | ||
dyn_float & | deadband, | ||
dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the smoothing config from the given data point element.
The function checks that the relevant driver is running. If not it returns an exception saying the config could not be read.
dpes | data point elements. Passed as reference only for performance reasons. Not modified. |
configExists | TRUE if smoothing config exists, else FALSE |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | Deadband value |
timeInterval | Time interval in seconds |
exceptionInfo | details of any errors are returned here |
fwSmoothing_getMany | ( | dyn_string & | dpes, |
dyn_bool & | configExists, | ||
dyn_int & | smoothProcedure, | ||
dyn_float & | deadband, | ||
dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the smoothing config from the given data point element.
The function checks that the relevant driver is running. If not it returns an exception saying the config could not be read.
dpes | data point elements. Passed as reference only for performance reasons. Not modified. |
configExists | TRUE if smoothing config exists, else FALSE |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | Deadband value |
timeInterval | Time interval in seconds |
exceptionInfo | details of any errors are returned here |
_fwSmoothing_getParameters | ( | dyn_string & | dpes, |
bool | isArchiveConfig, | ||
dyn_int & | smoothProcedure, | ||
dyn_float & | deadband, | ||
dyn_float & | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
int | groupNumber = 1 |
||
) |
Gets the parameters of the smoothing in the archiving or smoothing config of a given dpe.
NOTE: This function does not check if the smoothing config exists nor if the archive config has smoothing configured (this must be done before using this function)
dpes | data point element |
isArchiveConfig | TRUE to read archive config smoothing parameters FALSE to read smoothing config smoothing parameters |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | deadband value returned here |
timeInterval | time in seconds returned here |
exceptionInfo | details of any errors are returned here |
_fwSmoothing_setParameters | ( | dyn_string | dpes, |
bool | isArchiveConfig, | ||
dyn_int | smoothProcedure, | ||
dyn_float | deadband, | ||
dyn_float | timeInterval, | ||
dyn_string & | exceptionInfo, | ||
bool | storeInParamHistory = TRUE , |
||
dyn_int | groupNumbers = makeDynInt() |
||
) |
Sets the parameters of the smoothing in the archiving or smoothing config of a given dpe.
NOTE: This function does not create the smoothing config nor set up smoothing for the archiving config (this must be done before using this function)
dpes | list of data point elements |
isArchiveConfig | TRUE to read archive config smoothing parameters FALSE to read smoothing config smoothing parameters |
smoothProcedure | DPATTR_VALUE_SMOOTH : value dependent, DPATTR_VALUE_REL_SMOOTH : relative value dependent, DPATTR_TIME_SMOOTH : time dependent, DPATTR_TIME_AND_VALUE_SMOOTH : value AND time dependent, DPATTR_TIME_AND_VALUE_REL_SMOOTH : relative value AND time dependent, DPATTR_TIME_OR_VALUE_SMOOTH : value OR time dependent, DPATTR_TIME_OR_VALUE_REL_SMOOTH : relative value OR time dependent, DPATTR_COMPARE_OLD_NEW : old-new comparison, DPATTR_OLD_NEW_AND_TIME_SMOOTH : old-new comparison AND time, DPATTR_OLD_NEW_OR_TIME_SMOOTH : old-new comparison OR time |
deadband | deadband value |
timeInterval | time in seconds |
exceptionInfo | details of any errors are returned here |
storeInParamHistory | Optional parameter (default value = TRUE) - TRUE to archive the parameter change, else FALSE |