Main Page | File List | File Members

fwCaV.ctl File Reference


Detailed Description

This library contains functions and constants needed by the fwCaV -

Creation Date
24/06/2004
Modification History
None
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author:
Milosz Marian Hulboj (IT-CO)

Function Documentation

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_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

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:
bitmapName name of Synoptics Bitmap for which the widget instance is created
instanceName name of widget instance
exceptionInfo returns 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:
plotName name of plot
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

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
bitmapName name of Synoptics Bitmap for which the widget instance is created
instanceName name of widget
exceptionInfo returns details of any errors

string fwCaV_genericDpeDescription string  dpe  ) 
 

Function used for obtaining description of a dpe in the generic DPT

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe datapoint 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
VISION, CTRL
Parameters:
dpe datapoint element about which data will be returned
Returns:
parameter UserData if exists. empty string otherwise

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:
dpe datapoint element about which data will be returned
Returns:
parameter name if exists. empty string otherwise

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:
dpe datapoint element about which data will be returned
elements Structure 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
exceptionInfo returns details of any errors

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:
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_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:
name name of the Synoptics Bitmap DP
parameters structure 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
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

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
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
  • 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)
exceptionInfo returns details of any errors

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:
name name of the widget
parameters structure 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
exceptionInfo returns details of any errors

fwCaV_isTimeoutActive string  dp,
int &  status,
dyn_string &  exceptionInfo
 

Function for querying the timeout status of the PLC

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dp - CaV plant/area/group datapoint
status - return code: 1 - timeout active; 0 - timeout inactive; -1 error
exceptionInfo - error handling

fwCaV_listPlots dyn_string &  list,
bool  stripSystemName = true
 

Returns the list of all plots.

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
list list of Plots
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)

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
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_listSynopticsPanels dyn_string &  list,
string  searchSystem = ""
 

Returns the list of all the synoptics panels.

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
list list of Synoptics Panels
searchSystem the system to search on - must include : (default = local system)

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:
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_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:
names names of the widget types
stripSystemName whether to strip the system name from the DPs (default = true)

fwCaV_registerPlot string  name,
dyn_string &  exceptionInfo
 

Function used for registering a new plot

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
name name of plot to register
exceptionInfo returns 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:
name name of panel to register
exceptionInfo returns details of any errors

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:
name name of the widget to register
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

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
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_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:
name name of the Synoptics Bitmap DP
parameters structure 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
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

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
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
  • 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)
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

Constraints
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
name name of the widget
parameters structure 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
exceptionInfo returns 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:
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_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:
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)

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


Generated on Wed Jan 16 11:22:44 2008 by  doxygen 1.3.9.1