fwCaV
8.4.0
|
fwCaV_genericParameterInfo (string dpe, dyn_string &elements, dyn_string &exceptionInfo) | |
string | fwCaV_genericDpeVarName (string dpe) |
string | fwCaV_genericDpeDescription (string dpe) |
string | fwCaV_genericDpeUserData (string dpe) |
fwCaV_registerWidgetType (string name, dyn_string &exceptionInfo) | |
fwCaV_unregisterWidgetType (string name, dyn_string &exceptionInfo, bool cascade=false) | |
fwCaV_listWidgetTypes (dyn_string &names, bool stripSystemName=true) | |
fwCaV_getWidgetTypeDetails (string name, dyn_dyn_string ¶meters, dyn_string &exceptionInfo) | |
fwCaV_setWidgetTypeDetails (string name, dyn_dyn_string parameters, dyn_string &exceptionInfo) | |
fwCaV_listSynopticsPanelWidgets (string panelname, dyn_string &list, dyn_string &exceptionInfo, bool stripSystemName=true) | |
fwCaV_listStrippedSynopticsPanelWidgets (string panelname, dyn_string &list, dyn_string &exceptionInfo) | |
fwCaV_registerSynopticsPanel (string name, dyn_string &exceptionInfo) | |
fwCaV_unregisterSynopticsPanel (string name, dyn_string &exceptionInfo, bool cascade=true) | |
fwCaV_listSynopticsPanels (dyn_string &list, string searchSystem="") | |
fwCaV_getSynopticsPanelDetails (string name, dyn_string ¶meters, dyn_string &exceptionInfo) | |
fwCaV_setSynopticsPanelDetails (string name, dyn_string parameters, dyn_string &exceptionInfo) | |
fwCaV_createWidgetInstance (string bitmapName, string instanceName, dyn_string &exceptionInfo) | |
fwCaV_deleteWidgetInstance (string bitmapName, string instanceName, dyn_string &exceptionInfo) | |
fwCaV_getWidgetInstanceDetails (string bitmapName, string instanceName, dyn_anytype ¶meters, dyn_string &exceptionInfo) | |
fwCaV_setWidgetInstanceDetails (string bitmapName, string instanceName, dyn_anytype parameters, dyn_string &exceptionInfo) | |
fwCaV_registerPlot (string name, dyn_string &exceptionInfo) | |
fwCaV_deletePlot (string plotName, dyn_string &exceptionInfo) | |
fwCaV_listPlots (dyn_string &list, bool stripSystemName=true) | |
fwCaV_getPlotInstanceDetails (string plotName, dyn_string &curves, bool &visible, dyn_string &exceptionInfo) | |
fwCaV_setPlotInstanceDetails (string plotName, dyn_string curves, bool visible, dyn_string &exceptionInfo) | |
_fwCaV_plotMenu (string dpe) | |
int | __fwCaV_obtainCurveNumber (string plotDp, string dpe) |
__fwCaV_plotMenuEntry (dyn_string &menu, string label, int value, bool enabled=true) | |
fwCaV_isTimeoutActive (string dp, int &status, dyn_string &exceptionInfo) | |
bool | isDriverRunning (dyn_int dui, int driverNum) |
fwCaV_connectCellBackColToValueStatus (dyn_string &exceptionInfo) | |
_fwCaV_calculateColourWithAlertCBValue (string dpe1, string alertColour, string dpe2, bool alarmActive, string dpe3, bool dataInvalid, string dpe4, string valText) | |
_fwCaV_calculateColourWithoutAlertCBValue (string dpe1, bool dataInvalid, string dpe2, string valText) | |
This library contains functions and constants needed by the fwCaV -
fwCaV_genericParameterInfo | ( | string | dpe, |
dyn_string & | elements, | ||
dyn_string & | exceptionInfo | ||
) |
Function used for obtaining information about a dpe in the generic DPT
dpe | datapoint element about which data will be returned |
elements | Structure with data corresponding to provided dpe:
|
exceptionInfo | returns details of any errors |
string fwCaV_genericDpeVarName | ( | string | dpe | ) |
Function used for obtaining variable name of a dpe in the generic DPT
dpe | datapoint element about which data will be returned |
string fwCaV_genericDpeDescription | ( | string | dpe | ) |
string fwCaV_genericDpeUserData | ( | string | dpe | ) |
fwCaV_registerWidgetType | ( | string | name, |
dyn_string & | exceptionInfo | ||
) |
Function used for registering a new widget type for use with Synoptics Bitmap facility
name | name of the widget to register |
exceptionInfo | returns details of any errors |
fwCaV_unregisterWidgetType | ( | string | name, |
dyn_string & | exceptionInfo, | ||
bool | cascade = false |
||
) |
Function used for unregistering a widget type with Synoptics Bitmap facility
name | name of the widget to unregister |
exceptionInfo | returns details of any errors |
cascade | whether to remove all the instances of this widget type (default = false) |
fwCaV_listWidgetTypes | ( | dyn_string & | names, |
bool | stripSystemName = true |
||
) |
Function used for listing all registered widget types for use with Synoptics Bitmap facility
names | names of the widget types |
stripSystemName | whether to strip the system name from the DPs (default = true) |
fwCaV_getWidgetTypeDetails | ( | string | name, |
dyn_dyn_string & | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
For a given Widget Type registered with Synoptics Bitmap facility returns the structure with all the parameters.
name | name of the widget |
parameters | structure with data about the given widget type
|
exceptionInfo | returns details of any errors |
fwCaV_setWidgetTypeDetails | ( | string | name, |
dyn_dyn_string | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
For a given Widget Type registered with Synoptics Bitmap facility sets the parameters which are passed in a structure
name | name of the widget |
parameters | structure with data about the given widget type
|
exceptionInfo | returns details of any errors |
fwCaV_listSynopticsPanelWidgets | ( | string | panelname, |
dyn_string & | list, | ||
dyn_string & | exceptionInfo, | ||
bool | stripSystemName = true |
||
) |
For a given Synoptics Bitmap panel, returns a list of all widgets belonging to that panel.
panelname | name of the Synoptics Bitmap dp |
list | list of widgets belonging to given Synoptics Panel |
exceptionInfo | returns details of any errors |
stripSystemName | whether to strip the system name from the DPs (default = true) |
fwCaV_listStrippedSynopticsPanelWidgets | ( | string | panelname, |
dyn_string & | list, | ||
dyn_string & | exceptionInfo | ||
) |
Variation of fwCaV_listSynopticsPanelWidgets. Returns only the widget instances names (without bitmapDp+"/" prefix)
panelname | name of the Synoptics Bitmap dp |
list | list of widgets belonging to given Synoptics Panel (only widget names, not dp names) |
exceptionInfo | returns details of any errors |
fwCaV_registerSynopticsPanel | ( | string | name, |
dyn_string & | exceptionInfo | ||
) |
Function used for registering a new Synoptics Bitmap panel
name | name of panel to register |
exceptionInfo | returns details of any errors |
fwCaV_unregisterSynopticsPanel | ( | string | name, |
dyn_string & | exceptionInfo, | ||
bool | cascade = true |
||
) |
Function used for deleting the Synoptics Bitmap DP
name | name of the SynopticsBitmap DP to remove |
exceptionInfo | returns details of any errors |
cascade | whether to remove all the widgets of that Synoptics Panel (default = true) |
fwCaV_listSynopticsPanels | ( | dyn_string & | list, |
string | searchSystem = "" |
||
) |
Returns the list of all the synoptics panels.
list | list of Synoptics Panels |
searchSystem | the system to search on - must include : (default = local system) |
fwCaV_getSynopticsPanelDetails | ( | string | name, |
dyn_string & | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
For a given Synoptics Bitmap facility returns the structure with all the parameters.
name | name of the Synoptics Bitmap DP |
parameters | structure with data about the given Synoptics Bitmap
|
exceptionInfo | returns details of any errors |
fwCaV_setSynopticsPanelDetails | ( | string | name, |
dyn_string | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
For a given Synoptics Bitmap facility sets the all the parameters according to data passed in the structure
name | name of the Synoptics Bitmap DP |
parameters | structure with data about the given Synoptics Bitmap
|
exceptionInfo | returns details of any errors |
fwCaV_createWidgetInstance | ( | string | bitmapName, |
string | instanceName, | ||
dyn_string & | exceptionInfo | ||
) |
Function used for creating a new instance of given Widget Type in given Synoptics Bitmap
bitmapName | name of Synoptics Bitmap for which the widget instance is created |
instanceName | name of widget instance |
exceptionInfo | returns details of any errors |
fwCaV_deleteWidgetInstance | ( | string | bitmapName, |
string | instanceName, | ||
dyn_string & | exceptionInfo | ||
) |
Function used for creating a new instance of given Widget Type in given Synoptics Bitmap
bitmapName | name of Synoptics Bitmap for which the widget instance is created |
instanceName | name of widget |
exceptionInfo | returns details of any errors |
fwCaV_getWidgetInstanceDetails | ( | string | bitmapName, |
string | instanceName, | ||
dyn_anytype & | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
Function returns a structure with information about the given Widget Instance
bitmapName | name of Synoptics Bitmap for which the widget instance is created |
instanceName | name of widget instance |
parameters | structure with data about the given Widget Instance
|
exceptionInfo | returns details of any errors |
fwCaV_setWidgetInstanceDetails | ( | string | bitmapName, |
string | instanceName, | ||
dyn_anytype | parameters, | ||
dyn_string & | exceptionInfo | ||
) |
Function sets information about the given Widget Instance according to the data in structure
bitmapName | name of Synoptics Bitmap for which the widget instance is created |
instanceName | name of widget instance |
parameters | structure with data about the given Widget Instance
|
exceptionInfo | returns details of any errors |
fwCaV_registerPlot | ( | string | name, |
dyn_string & | exceptionInfo | ||
) |
Function used for registering a new plot
name | name of plot to register |
exceptionInfo | returns details of any errors |
fwCaV_deletePlot | ( | string | plotName, |
dyn_string & | exceptionInfo | ||
) |
Function used for deleting a plot
plotName | name of plot |
exceptionInfo | returns details of any errors |
fwCaV_listPlots | ( | dyn_string & | list, |
bool | stripSystemName = true |
||
) |
Returns the list of all plots.
list | list of Plots |
stripSystemName | whether to strip the system name from the DPs (default = true) |
fwCaV_getPlotInstanceDetails | ( | string | plotName, |
dyn_string & | curves, | ||
bool & | visible, | ||
dyn_string & | exceptionInfo | ||
) |
Function returns a structure with information about the given Plot Instance
plotName | name of plot instance |
curves | structure with data of the curves about the given Plot Instance |
visible | whether the Plot is displayed |
exceptionInfo | returns details of any errors |
fwCaV_setPlotInstanceDetails | ( | string | plotName, |
dyn_string | curves, | ||
bool | visible, | ||
dyn_string & | exceptionInfo | ||
) |
Function sets information about the given Plot Instance according to the data in structure
plotName | name of plot instance |
curves | structure with data of the curves about the given Plot Instance |
visible | whether the Plot is displayed |
exceptionInfo | returns details of any errors |
_fwCaV_plotMenu | ( | string | dpe | ) |
Function displaying the "right-click" menu for the synoptics bitmap with various plotting opitons.
dpe | - dpe element upon which the plot operations will be done |
int __fwCaV_obtainCurveNumber | ( | string | plotDp, |
string | dpe | ||
) |
Function checks if the given dpe is present as a curve in a certain plot
plotDp | - plot datapoint to be examined |
dpe | - dpe to look for |
__fwCaV_plotMenuEntry | ( | dyn_string & | menu, |
string | label, | ||
int | value, | ||
bool | enabled = true |
||
) |
Helper function for constructing the plot menu
menu | - dyn_string containing the menu parameters to which new data shall be appended |
label | - the label of the new entry |
value | - return value of the label (returned when the label is clicked) |
enabled | - whether the entry is enabled (true by default) |
fwCaV_isTimeoutActive | ( | string | dp, |
int & | status, | ||
dyn_string & | exceptionInfo | ||
) |
bool isDriverRunning | ( | dyn_int | dui, |
int | driverNum | ||
) |
Function for checking if the MODBUS driver is running
dui | - dyn string with the number of the managers which are running |
driverNum | - number of the manager for the ModBus driver |
fwCaV_connectCellBackColToValueStatus | ( | dyn_string & | exceptionInfo | ) |
This function controls the background colour of the cell of a table from within which the function was called. The colour is controlled by dpConnecting to the invalid bit of the given data point element, and if it exists, the alert active bit and the alert colour are also connected to. When the function is called, and any time when the alert state or invalid state changes, a function is called which evaluates the current state, selects the relevant colour and sets the background colour of the graphical item.
exceptionInfo | details of any exceptions are placed in here. |
_fwCaV_calculateColourWithAlertCBValue | ( | string | dpe1, |
string | alertColour, | ||
string | dpe2, | ||
bool | alarmActive, | ||
string | dpe3, | ||
bool | dataInvalid, | ||
string | dpe4, | ||
string | valText | ||
) |
This functions takes the given states of a data point element and calls a function which calcultes the relevant colour. The function then set the background colour of graphical item "this" to that colour.
dpe1 | data point element |
alertColour | a string containing the name of the current alert colour |
dpe2 | data point element |
alarmActive | a bit to represent if alert handling is active or not (TRUE = active, FALSE = inactive) |
dpe3 | data point element |
dataInvalid | a bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid) |
dpe4 | data point element with value to display in the cell |
valText | value to display in the cell |
_fwCaV_calculateColourWithoutAlertCBValue | ( | string | dpe1, |
bool | dataInvalid, | ||
string | dpe2, | ||
string | valText | ||
) |
This functions takes the given states of a data point element and calls a function which calcultes the relevant colour. The function then set the background colour of graphical item "this" to that colour.
dpe1 | data point element with quality of the data |
dataInvalid | a bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid) |
dpe2 | data point element with value to display in the cell |
valText | value to display in the cell |