fwCaV  8.4.0
fwCaV.ctl File Reference
 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 &parameters, 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 &parameters, 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 &parameters, 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)
 

Detailed Description

This library contains functions and constants needed by the fwCaV -

  • the Cooling and Ventilation
Creation Date
24/06/2004
Modification History
05/10/2011 Daniel Davids - ove of fwColourTable functions into fwCaV
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Milosz Marian Hulboj (IT-CO)

Function Documentation

fwCaV_genericParameterInfo ( string  dpe,
dyn_string &  elements,
dyn_string &  exceptionInfo 
)
Function used for obtaining information about a dpe in the generic DPT
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpedatapoint element about which data will be returned
elementsStructure with data corresponding to provided dpe:
  • elements[fwCaV_genericDpe] - datapoint element suffix (without dpName)
  • elements[fwCaV_genericVarName] - element name (usually variable name from the SCY)
  • elements[fwCaV_genericDescription] - element description
  • elements[fwCaV_genericUserData] - element specific UserData
exceptionInforeturns details of any errors
string fwCaV_genericDpeVarName ( string  dpe)
Function used for obtaining variable name of a dpe in the generic DPT
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpedatapoint element about which data will be returned
Returns
parameter name if exists. empty string otherwise
string fwCaV_genericDpeDescription ( string  dpe)
Function used for obtaining description of a dpe in the generic DPT
Constraints
Usage
Public
PVSS managers
Reviewed:
2018-08-16 API VISION, CTRL
Parameters
dpedatapoint element about which data will be returned
Returns
parameter description if exists. empty string otherwise
string fwCaV_genericDpeUserData ( string  dpe)
Function used for obtaining UserData about a dpe in the generic DPT
Constraints
Usage
Public
PVSS managers
Reviewed:
2018-08-16 API VISION, CTRL
Parameters
dpedatapoint element about which data will be returned
Returns
parameter UserData if exists. empty string otherwise
fwCaV_registerWidgetType ( string  name,
dyn_string &  exceptionInfo 
)
Function used for registering a new widget type for use with Synoptics Bitmap facility
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the widget to register
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the widget to unregister
exceptionInforeturns details of any errors
cascadewhether 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namesnames of the widget types
stripSystemNamewhether 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.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the widget
parametersstructure with data about the given widget type
  • parameters[fwCaV_WidgetDefinition_Filename] - filename of the panel
  • parameters[fwCaV_WidgetDefinition_Description] - description of the widget
  • parameters[fwCaV_WidgetDefinition_DpeDescriptions] - dyn_string with descriptions what a given dpe passed to the widget means
  • parameters[fwCaV_WidgetDefinition_ExtraParametersDescription] - dyn_string with descriptions what a given extra parameter passed to the widget means
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the widget
parametersstructure with data about the given widget type
  • parameters[fwCaV_WidgetDefinition_Filename] - filename of the panel
  • parameters[fwCaV_WidgetDefinition_Description] - description of the widget
  • parameters[fwCaV_WidgetDefinition_DpeDescriptions] - dyn_string with descriptions what a given dpe passed to the widget means
  • parameters[fwCaV_WidgetDefinition_ExtraParametersDescription] - dyn_string with descriptions what a given extra parameter passed to the widget means
exceptionInforeturns 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.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
panelnamename of the Synoptics Bitmap dp
listlist of widgets belonging to given Synoptics Panel
exceptionInforeturns details of any errors
stripSystemNamewhether 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)
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
panelnamename of the Synoptics Bitmap dp
listlist of widgets belonging to given Synoptics Panel (only widget names, not dp names)
exceptionInforeturns details of any errors
fwCaV_registerSynopticsPanel ( string  name,
dyn_string &  exceptionInfo 
)
Function used for registering a new Synoptics Bitmap panel
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of panel to register
exceptionInforeturns details of any errors
fwCaV_unregisterSynopticsPanel ( string  name,
dyn_string &  exceptionInfo,
bool  cascade = true 
)
Function used for deleting the Synoptics Bitmap DP
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the SynopticsBitmap DP to remove
exceptionInforeturns details of any errors
cascadewhether 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.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
listlist of Synoptics Panels
searchSystemthe 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.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the Synoptics Bitmap DP
parametersstructure with data about the given Synoptics Bitmap
  • parameters[fwCaV_SynopticsBitmap_Image] - path to the bitmap file (image)
  • parameters[fwCaV_SynopticsBitmap_Description] - description of the Synoptics Bitmap
  • parameters[fwCaV_SynopticsBitmap_Size_x] - x size (in pixels)
  • parameters[fwCaV_SynopticsBitmap_Size_y] - y size (in pixels)
  • parameters[fwCaV_SynopticsBitmap_PlotType] - size for the plots
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of the Synoptics Bitmap DP
parametersstructure with data about the given Synoptics Bitmap
  • parameters[fwCaV_SynopticsBitmap_Image] - path to the bitmap file (image)
  • parameters[fwCaV_SynopticsBitmap_Description] - description of the Synoptics Bitmap
  • parameters[fwCaV_SynopticsBitmap_Size_x] - x size (in pixels)
  • parameters[fwCaV_SynopticsBitmap_Size_y] - y size (in pixels)
  • parameters[fwCaV_SynopticsBitmap_PlotType] - size for the plots
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bitmapNamename of Synoptics Bitmap for which the widget instance is created
instanceNamename of widget instance
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bitmapNamename of Synoptics Bitmap for which the widget instance is created
instanceNamename of widget
exceptionInforeturns 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 
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bitmapNamename of Synoptics Bitmap for which the widget instance is created
instanceNamename of widget instance
parametersstructure with data about the given Widget Instance
  • parameters[fwCaV_SynopticsBitmap_Type] - Widget Type
  • parameters[fwCaV_WidgetInstance_DeviceDp] - Which Framework the widget is connecting to
  • parameters[fwCaV_WidgetInstance_Properties] - To which properties of that Device
  • parameters[fwCaV_WidgetInstance_ExtraParameters] - extra parameters passed to widget refpanel
  • parameters[fwCaV_WidgetInstance_Visible] - whether the Widget Instance is displayed
  • parameters[fwCaV_WidgetInstance_Position_x] - x relative position (in percents)
  • parameters[fwCaV_WidgetInstance_Position_y] - y relative position (in percents)
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bitmapNamename of Synoptics Bitmap for which the widget instance is created
instanceNamename of widget instance
parametersstructure with data about the given Widget Instance
  • parameters[fwCaV_SynopticsBitmap_Type] - Widget Type
  • parameters[fwCaV_WidgetInstance_deviceDp] - Which Framework the widget is connecting to
  • parameters[fwCaV_WidgetInstance_properties] - To which properties of that Device
  • parameters[fwCaV_WidgetInstance_extraParameters] - extra parameters passed to widget refpanel
  • parameters[fwCaV_WidgetInstance_visible] - whether the Widget Instance is displayed
  • parameters[fwCaV_WidgetInstance_Position_x] - x relative position (in percents)
  • parameters[fwCaV_WidgetInstance_Position_y] - y relative position (in percents)
exceptionInforeturns details of any errors
fwCaV_registerPlot ( string  name,
dyn_string &  exceptionInfo 
)
Function used for registering a new plot
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
namename of plot to register
exceptionInforeturns details of any errors
fwCaV_deletePlot ( string  plotName,
dyn_string &  exceptionInfo 
)
Function used for deleting a plot
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
plotNamename of plot
exceptionInforeturns details of any errors
fwCaV_listPlots ( dyn_string &  list,
bool  stripSystemName = true 
)
Returns the list of all plots.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
listlist of Plots
stripSystemNamewhether 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 
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
plotNamename of plot instance
curvesstructure with data of the curves about the given Plot Instance
visiblewhether the Plot is displayed
exceptionInforeturns 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
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
plotNamename of plot instance
curvesstructure with data of the curves about the given Plot Instance
visiblewhether the Plot is displayed
exceptionInforeturns details of any errors
_fwCaV_plotMenu ( string  dpe)
Function displaying the "right-click" menu for the synoptics bitmap
with various plotting opitons.
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
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
Constraints
Usage
Private
PVSS managers
VISION, CTRL
Parameters
plotDp- plot datapoint to be examined
dpe- dpe to look for
Returns
the curve number or -1 if not found
__fwCaV_plotMenuEntry ( dyn_string &  menu,
string  label,
int  value,
bool  enabled = true 
)
Helper function for constructing the plot menu
Constraints
Usage
Private
PVSS managers
VISION, CTRL
Parameters
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 
)
Function for querying the timeout status of the PLC
Constraints
Usage
Public
PVSS managers
Reviewed:
2018-08-16 API VISION, CTRL
Parameters
dp- CaV plant/area/group datapoint
status- return code: 1 - timeout active; 0 - timeout inactive; -1 error
exceptionInfo- error handling
bool isDriverRunning ( dyn_int  dui,
int  driverNum 
)
Function for checking if the MODBUS driver is running
Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters
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.

Modification History
29/03/01 Oliver Holme Added functionality for connecting to dpes of type STRUCTURE This makes it possible to connect to the state of a summary alert 05/10/11 Daniel Davids Move of fwColourTable into here and adapted...
Constraints
Usage
Public
PVSS managers
VISION
Parameters
exceptionInfodetails 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.

Modification History
05/10/11 Daniel Davids Move of fwColourTable into here and adapted...
Constraints
This function is designed as a 'work' function and should only be used by giving it as the function name in a dpConnect statement
Usage
Private
PVSS managers
VISION
Parameters
dpe1data point element
alertColoura string containing the name of the current alert colour
dpe2data point element
alarmActivea bit to represent if alert handling is active or not (TRUE = active, FALSE = inactive)
dpe3data point element
dataInvalida bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid)
dpe4data point element with value to display in the cell
valTextvalue 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.

Modification History
05/10/11 Daniel Davids Move of fwColourTable into here and adapted...
Constraints
This function is designed as a 'work' function and should only be used by giving it as the function name in a dpConnect statement
Usage
Private
PVSS managers
VISION
Parameters
dpe1data point element with quality of the data
dataInvalida bit to represent if data is invalid or not (TRUE = invalid, FALSE = valid)
dpe2data point element with value to display in the cell
valTextvalue to display in the cell