Main Page | File List | File Members

fwGeneral.ctl File Reference


Detailed Description

Creation Date
24/03/04
Constraints
None
Author:
Manuel Gonzalez Berges (IT-CO)

Function Documentation

fwGeneral_commandConfirmation string  dpe,
string  command,
bool &  confirmation,
dyn_string &  exceptionInfo
 

Opens confirmation dialog panel, and returns result user selection

Constraints
None
Usage
Public
PVSS managers
VISION
Parameters:
dpe name of the datapoint where the command will be applied
command short explanation of the action to be confirmed
confirmation whether the user confirmed the command or not
exceptionInfo returns details of any errors

void fwGeneral_DpTypeSelector dyn_string &  selectedDpTypes,
dyn_string  disabledDpTypes,
dyn_string &  exceptionInfo,
bool  selectMultiple = FALSE,
string  text = ""
 

Opens the datapoint type selector panel and return the user selection

Constraints
None
Usage
Public
PVSS maangers
VISION
Parameters:
selectedDpTypes returns the list of selected DP Types (one or multiple, depending on selectMultiple parameter. If specified as input it can contain the pre-defined selection.
disabledDpTypes list of DP Types that are disabled in the selection list. Specifying empty list means that all items are selectable
exceptionInfo returns details of any errors
selectMultiple determines if the selection list allows for multiple selection, or single selection only.
text panel title. If an empty string is specified, then "Select Datapoint Types" will be used.

fwGeneral_dynStringToString dyn_string  theDynString,
string &  theString,
string  separator = "|"
 

Converts a dyn_string to a string with the chosen separator.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
theDynString dyn_string to be converted
theString result of the conversion
separator separator used for splitting. The default value should be fwGeneral_DYN_STRING_DEFAULT_SEPARATOR, but PVSS doesn't allow constants in default arguments

fwGeneral_fillDynString dyn_string &  ds,
int  length,
dyn_string &  exceptionInfo,
string  value = ""
 

Fills in the a dynamic string with the selected value (null by default) until it has at least the required length. If the initial length of the dynamic string is equal or more than the requested length, then it is not changed.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
ds the dynamic string to be modified
length minimum length required for the dynamic string
exceptionInfo returns details of any exceptions
value value to be used to fill in the array

fwGeneral_getDpElements string  dp,
string  dpType,
dyn_string &  dpElements,
dyn_string &  dpElementTypes,
dyn_string &  exceptionInfo,
dyn_int  excludedTypes
 

Returns a list with the dpes in a dp or a dp type. The method used is a workaround, because the function dpTypeGet doesn't return the dpes when there is a reference to another type.

Constraints
If a dp type is specified , at least one datapoint of the type has to exist
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dp datapoint to get the elements from
dpType dp type to get the elements from if no datapoint was specified (dp = "")
dpElements returns the list of dp elements
dpElementTypes returns the list of types of corresponding to the list of dp elements
exceptionInfo returns details of any exceptions
excludedTypes excluded dp elements of these types from the list

fwGeneral_getDynDpeTypes dyn_string &  dynTypes,
dyn_string &  exceptionInfo
 

Returns the a list of dynamic types for dpes

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dynTypes list of integer values of dynamic dpe types (does not dyn_anytype or any dyn_dyn)
exceptionInfo details of any exceptions

fwGeneral_getGlobalValue string  globalVariable,
anytype &  value,
dyn_string &  exceptionInfo
 

Returns the value of a global variable

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
globalVariable name of the global variable to get the value from
value returns the value of the global variable
exceptionInfo details of any exceptions

fwGeneral_getNameWithoutSN string  name,
string &  nameWithoutSN,
dyn_string &  exceptionInfo
 

Removes the system name from the passed name. name can be a DP name or a DP alias. dpSubStr is not used because it only works if the dp exists.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
name name to be processed
nameWithoutSN name with system name removed
exceptionInfo details of any exceptions

fwGeneral_getSystemIpAddress string  systemName,
string &  ipAddress,
string &  hostName,
dyn_string &  exceptionInfo
 

Returns ipAddress and hostName where the PVSS system with name systemName is running.

Constraints
Local system not supported. The remote system has to be connected at the time the function is called.
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
systemName name of the system we are interested in
ipAddress ip address of the machine where the PVSS system is running
hostName host name of the machine where the PVSS system is running
exceptionInfo returns details of any exceptions

fwGeneral_getSystemName string  name,
string &  systemName,
dyn_string &  exceptionInfo
 

Gets the system name from the passed name. name can be a DP name or a DP alias. dpSubStr is not used because it only works if the dp exists.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
name name to be processed (e.g. system1:crate01/board03/channel005)
systemName system name extracted from name (e.g. system1:)
exceptionInfo details of any exceptions

fwGeneral_init dyn_string &  exceptionInfo  ) 
 

Initializes global constants provided by the library

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
exceptionInfo details of any exceptions

fwGeneral_isDpeTypeDyn int  type,
bool &  isDyn,
dyn_string &  exceptionInfo
 

Returns whether the dpe type is dyn or not

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
type integer number for dpe type
isDyn whether the dpetype is dyn or not
exceptionInfo details of any exceptions

fwGeneral_openDetailsPanel string  dpe,
dyn_string &  exceptionInfo
 

Opens the details panel for a given datapoint element

Constraints
None
Usage
Public
PVSS managers
VISION
Parameters:
dpe datapoint element to get the details from
exceptionInfo details of any exceptions

fwGeneral_openMessagePanel string  message,
bool &  ok,
dyn_string &  exceptionInfo,
string  panelBarTitle = "",
bool  onlyInfo = FALSE
 

Opens a message panel with the specified message. If it is used as a dialog (onlyInfo = FALSE) it will return whether the user pressed Ok or not. If it is used as information panel it will just display the panel and wait for the user to press Ok.

Constraints
None
Usage
Public
PVSS manager usage VISION

Parameters:
message the message to be presented in the panel
ok returns TRUE if the user pressed the Ok button, FALSE otherwise
exceptionInfo details of any exceptions
panelBarTitle title for the panel
onlyInfo whether the panel is just for information, or it will also ask for user input

fwGeneral_selectFromList dyn_string  list,
dyn_string &  selection,
dyn_string &  exceptionInfo,
bool  multipleSelection = false,
string  title = "Select fromt the list"
 

Opens a panel to select one or several of the items in a list

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
list list of strings to select from
selection returns the selected items
exceptionInfo details of any exceptions
multipleSelection whether it is possible to select more than one item or not
title title of the pop-up window with the dialog box

fwGeneral_setGlobalValue string  globalVariable,
anytype  value,
dyn_string &  exceptionInfo
 

Sets the value of a global variable

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
globalVariable name of the global variable to set the value to
value the value to be set to the global variable
exceptionInfo details of any exceptions

fwGeneral_stringToDynString string  theString,
dyn_string &  theDynString,
string  separator = "|",
bool  removeSpaces = true,
bool  compatibilityMode = false
 

Converts a string to a dyn_string with the chosen separator.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
theString string to be split
theDynString result of splitting
separator separator used for splitting. The default value should be fwGeneral_DYN_STRING_DEFAULT_SEPARATOR, but PVSS doesn't allow constants in default arguments
removeSpaces whether to remove spaces in the string before parsing it or not
compatibilityMode useful to parse strings that are the result of the automatic conversion by PVSS of a dyn_string to a string. In this case, the parts are separated by " | " (space-tube-space). If you want to get the original dyn_string, set this parameter to TRUE.


Generated on Mon Mar 13 16:57:39 2006 by doxygen 1.3.5