fwConfigs
8.4.3
|
This library contains function associated with the address config. Functions are provided for getting the current settings, deleting the config and setting the config. More...
Basic Functions | |
fwPeriphAddress_get (string dpe, bool &configExists, dyn_anytype &config, bool &isActive, dyn_string &exceptionInfo) | |
Get the address config of a datapoint element. More... | |
fwPeriphAddress_getMany (dyn_string &dpes, dyn_bool &configExists, dyn_dyn_anytype &config, dyn_bool &isActive, dyn_string &exceptionInfo) | |
Get the address config of a datapoint element. More... | |
fwPeriphAddress_set (string dpe, dyn_anytype configParameters, dyn_string &exceptionInfo, bool runDriverCheck=FALSE, bool setWait=TRUE) | |
Set the address config for a given data point element. More... | |
fwPeriphAddress_setMany (dyn_string &dpes, dyn_dyn_anytype &configParameters, dyn_string &exceptionInfo, bool runDriverCheck=FALSE, bool setWait=TRUE) | |
Sets the address config for a given set of data point elements See fwPeriphAddress_set() for an example. More... | |
This library contains function associated with the address config. Functions are provided for getting the current settings, deleting the config and setting the config.
14/07/2014 Jean-Charles Tournier
09/04/2014 Marco Boccioli
31/03/2014 Marco Boccioli
22/11/2013 Marco Boccioli, Alexey Merezhin
12/11/2013 Marco Boccioli
09/09/2013 Marco Boccioli
18/07/2013 Marco Boccioli
18/02/2013 Jean-Charles Tournier
15/01/2013 Marco Boccioli
12/08/2011 Marco Boccioli
12/08/2011 Marco Boccioli
27/04/2010 Frederic Bernard (EN-ICE) update Exception management in fwPeriphAddress_setModbus()
15/01/2004 Oliver Holme (IT-CO) Modified library to match functionality of other config libs
fwPeriphAddress_get | ( | string | dpe, |
bool & | configExists, | ||
dyn_anytype & | config, | ||
bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Get the address config of a datapoint element.
The function checks that the relevant driver is running. If not it returns an exception saying the config could not be read.
dpe | datapoint element to read from |
configExists | TRUE if address config exists, else FALSE |
config | Address object is returned here (configParameters). See description for configParameters on fwPeriphAddress_set() |
isActive | TRUE is address config is active, else FALSE |
exceptionInfo | details of any errors are returned here |
fwPeriphAddress_getMany | ( | dyn_string & | dpes, |
dyn_bool & | configExists, | ||
dyn_dyn_anytype & | config, | ||
dyn_bool & | isActive, | ||
dyn_string & | exceptionInfo | ||
) |
Get the address config of a datapoint element.
The function checks that the relevant driver is running. If not it returns an exception saying the config could not be read.
dpes | datapoint element to read from. Passed as reference for performance reasons. Not modified. |
configExists | TRUE if address config exists, else FALSE |
config | address object is returned here. See fwPeriphAddress_get() for details on the addess object. |
isActive | TRUE is address config is active, else FALSE |
exceptionInfo | details of any errors are returned here |
fwPeriphAddress_set | ( | string | dpe, |
dyn_anytype | configParameters, | ||
dyn_string & | exceptionInfo, | ||
bool | runDriverCheck = FALSE , |
||
bool | setWait = TRUE |
||
) |
Set the address config for a given data point element.
Example: S7.
It connects the dpe sys_1:testPerAddr.input to the element DB81.DBD0F. The PLC connection is defined on Test_PLC.
Example: OPC UA.
It connects the dpe sys_1:testPerAddr.input to the element OPCUAConnection1$subscription2$1$1$item1. The OPC UA Client connection is defined on OPCUAConnection1.
dpe | datapoint element to act on |
configParameters | Address object is passed here:
|
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 |
setWait | determines if dpSetWait or dpSet should be used |
fwPeriphAddress_setMany | ( | dyn_string & | dpes, |
dyn_dyn_anytype & | configParameters, | ||
dyn_string & | exceptionInfo, | ||
bool | runDriverCheck = FALSE , |
||
bool | setWait = TRUE |
||
) |
Sets the address config for a given set of data point elements See fwPeriphAddress_set() for an example.
dpes | list of datapoint elements to act on |
configParameters | Address objects are passed here, one per dpe. See fwPeriphAddress_set() for details. |
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 |