fwGeneral
8.4.1
|
global const dyn_int | g_fwGeneral_dynDpeTypes |
constants representing dynamic dpe types More... | |
void | fwGeneral_commandConfirmation (string dpe, string command, bool &confirmation, dyn_string &exceptionInfo) |
time | fwGeneral_dateTimeWidget_getEndDateTime (bool &bOk, dyn_string &dsException) |
time | fwGeneral_dateTimeWidget_getStartDateTime (bool &bOk, dyn_string &dsException) |
string | fwGeneral_dateTimeWidget_getTimeZone () |
bool | fwGeneral_dateTimeWidget_positivePeriodSelected (dyn_string &dsException) |
void | fwGeneral_dateTimeWidget_setEnabled (bool bState) |
public bool | fwGeneral_dateTimeWidget_isEnabled () |
void | fwGeneral_dateTimeWidget_setEndDateTime (time tDateTime) |
void | fwGeneral_dateTimeWidget_setStartDateTime (time tDateTime) |
void | fwGeneral_dateTimeWidget_setTimeZone (string sTimeZone) |
void | fwGeneral_dateTimeWidget_setVisible (bool bState) |
void | fwGeneral_DpTypeSelector (dyn_string &selectedDpTypes, dyn_string disabledDpTypes, dyn_string &exceptionInfo, bool selectMultiple=FALSE, string text="") |
void | fwGeneral_dynStringToString (dyn_string theDynString, string &theString, string separator=fwGeneral_DYN_STRING_DEFAULT_SEPARATOR) |
void | fwGeneral_fillDynString (dyn_string &ds, int length, dyn_string &exceptionInfo, string value="") |
void | fwGeneral_getDpElements (string dp, string dpType, dyn_string &dpElements, dyn_string &dpElementTypes, dyn_string &exceptionInfo, dyn_int excludedTypes="", bool forceDpCreation=false) |
void | fwGeneral_getGlobalValue (string globalVariable, anytype &value, dyn_string &exceptionInfo) |
string | fwSysName (string name, bool keepColon=false) |
string | fwNoSysName (string name) |
void | fwGeneral_getNameWithoutSN (string name, string &nameWithoutSN, dyn_string &exceptionInfo) |
void | fwGeneral_getSystemIpAddress (string systemName, string &ipAddress, string &hostName, dyn_string &exceptionInfo) |
void | fwGeneral_getSystemName (string name, string &systemName, dyn_string &exceptionInfo) |
bool | fwGeneral_hasCorrectDateFormat (string sDate) |
bool | fwGeneral_hasCorrectFormat (string sDateTime) |
bool | fwGeneral_hasCorrectTimeFormat (string sTime) |
void | fwGeneral_isDpeTypeDyn (int type, bool &isDyn, dyn_string &exceptionInfo) |
void | fwGeneral_openDetailsPanel (string dpe, dyn_string &exceptionInfo) |
void | fwGeneral_openMessagePanel (string message, bool &ok, dyn_string &exceptionInfo, string panelBarTitle="", bool onlyInfo=FALSE) |
void | fwGeneral_selectFromList (dyn_string list, dyn_string &selection, dyn_string &exceptionInfo, bool multipleSelection=false, string title="Select fromt the list") |
void | fwGeneral_setGlobalValue (string globalVariable, anytype value, dyn_string &exceptionInfo) |
void | fwGeneral_stringToDynString (string theString, dyn_string &theDynString, string separator="|", bool removeSpaces=true, bool compatibilityMode=false) |
time | fwGeneral_stringToDate (string sDateTime) |
string | fwGeneral_recodeFile (string fnameToRecode, dyn_string &exceptionInfo) |
void | fwGeneral_getQueryRDBdirectEnabled (bool &queryRDBdirectEnabled) |
void | fwGeneral_getParallelArchivingEnabled (bool &RDBinstalled, bool ¶llelArchivingEnabled) |
void | fwGeneral_setQueryRDBdirectEnabled (bool queryRDBdirectEnabled) |
string | fwGeneral_getFileExtension (string filePath) |
string | fwGeneral_removeFileExtension (string filePath) |
void | fwGeneral_setHelpUseInternalBrowser (bool useInternalBrowser, dyn_string &exceptionInfo) |
void | fwGeneral_getHelpUseInternalBrowser (bool &useInternalBrowser, dyn_string &exceptionInfo) |
int | fwGeneral_setHelpExtBrowserCommand (string browserCmdLin, string browserCmdWin, dyn_string &exceptionInfo) |
int | fwGeneral_getHelpExtBrowserCommand (string &browserCmdLin, string &browserCmdWin, dyn_string &exceptionInfo) |
private void | fwGeneral_openHelpFile (string helpFilePath, dyn_string &exceptionInfo, string label="", string windowName="fwGeneralHelp") |
void | fwGeneral_openInExternalBrowser (string url, dyn_string &exceptionInfo) |
void | fwGeneral_openHelpForPanel (string panelFilePath, dyn_string &exceptionInfo) |
void | fwGeneral_openHelpForComponent (string componentName, dyn_string &exceptionInfo) |
void | FWDEPRECATED () |
void | _fwGeneral_fwDeprecatedClear () |
private void | _fwGeneral_displayDeprecatedLabel (int x=0, int y=0) |
bool | fwGeneral_loadCtrlLib (string libRelPath, bool excOnNotFound=true, bool useBeyondInit=false) |
void fwGeneral_commandConfirmation | ( | string | dpe, |
string | command, | ||
bool & | confirmation, | ||
dyn_string & | exceptionInfo | ||
) |
Opens confirmation dialog panel, and returns result user selection
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 |
time fwGeneral_dateTimeWidget_getEndDateTime | ( | bool & | bOk, |
dyn_string & | dsException | ||
) |
Returns end date and time selected by the user and performs format check.
bOk | Output - Returns info whether provided times were in correct format or not. In case of wrong format, current time is given back as return value. |
dsException | - Input/Output: Carrier for exception message to be shown to user |
time fwGeneral_dateTimeWidget_getStartDateTime | ( | bool & | bOk, |
dyn_string & | dsException | ||
) |
Returns start date and time selected by the user and performs format check.
bOk | Output - Returns info whether provided times were in correct format or not. In case of wrong format, current time is given back as return value. |
dsException | - Input/Output: Carrier for exception message to be shown to user |
string fwGeneral_dateTimeWidget_getTimeZone | ( | ) |
Returns the time zone used to determine the current time.
bool fwGeneral_dateTimeWidget_positivePeriodSelected | ( | dyn_string & | dsException | ) |
Checks whether the user has selected a positive time interval in the date/time widget or not.
dsException | - Input/Output: Carrier for exception message to be shown to user |
void fwGeneral_dateTimeWidget_setEnabled | ( | bool | bState | ) |
Enables or disables the UI elements of the Date Time Widget. !!! Make sure widget is initialised before using this function. !!! (If you want to enable/disable upon initialization, use the provided $-parameter)
bState | Input - boolean: state |
public bool fwGeneral_dateTimeWidget_isEnabled | ( | ) |
Is the DateTime widget enabled?
void fwGeneral_dateTimeWidget_setEndDateTime | ( | time | tDateTime | ) |
Sets the end date and time in the Date Time Widget.
Input | - time: date and time |
void fwGeneral_dateTimeWidget_setStartDateTime | ( | time | tDateTime | ) |
Sets the start date and time in the Date Time Widget.
Input | - time: date and time |
void fwGeneral_dateTimeWidget_setTimeZone | ( | string | sTimeZone | ) |
Sets the time zone used to determine the current time.
Input | - string: time zone (e.g. FW_GENERAL_NATURAL_TIME_FORMAT, FW_GENERAL_GENERIC_TIME_FORMAT) |
void fwGeneral_dateTimeWidget_setVisible | ( | bool | bState | ) |
Makes the UI elements of the Date Time Widget visible/invisible while still allowing for the different modes (date and time vs. only date; time zone shown). !!! Make sure the widget is initialised before using this function. !!!
bState | Input - boolean: state |
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
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. |
void fwGeneral_dynStringToString | ( | dyn_string | theDynString, |
string & | theString, | ||
string | separator = fwGeneral_DYN_STRING_DEFAULT_SEPARATOR |
||
) |
Converts a dyn_string to a string with the chosen separator.
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 |
void fwGeneral_fillDynString | ( | dyn_string & | ds, |
int | length, | ||
dyn_string & | exceptionInfo, | ||
string | value = "" |
||
) |
Extend a dynamic string to the specified length. Initialise the newly added entries (strings) with the initial value given (null by default). If the initial length of the dynamic string is already longer than (or equal to) the requested length, then we leave the original dynamic string unchanged.
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 |
void fwGeneral_getDpElements | ( | string | dp, |
string | dpType, | ||
dyn_string & | dpElements, | ||
dyn_string & | dpElementTypes, | ||
dyn_string & | exceptionInfo, | ||
dyn_int | excludedTypes = "" , |
||
bool | forceDpCreation = false |
||
) |
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.
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 sorted into alphabetical order. NB Their name(s) begin with "." ! |
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 |
forceDpCreation | if there are no dps of the specified type, it is possible to force the creation of a dummy dp to be able to get the structure |
void fwGeneral_getGlobalValue | ( | string | globalVariable, |
anytype & | value, | ||
dyn_string & | exceptionInfo | ||
) |
Returns the value of a global variable
globalVariable | name of the global variable to get the value from |
value | returns the value of the global variable |
exceptionInfo | details of any exceptions |
string fwSysName | ( | string | name, |
bool | keepColon = false |
||
) |
Returns the system name extracted from the passed string
The function parses the passed name
parameter in search of the first colon (:) character, and returns the substring prior to it. Typical use case is to get the name of the system from the name of a datapoint.
Contrary to builtin dpSubStr(), the function may be called for any string, not necessarily being the name of an existing datapoint. It is safe to use with UTF strings.
See also fwGeneral_getSystemName
name | string from which the system name is to be extracted; |
keepColon | (optional) determines if returned system name should contain the colon character (default: no). |
string fwNoSysName | ( | string | name | ) |
Returns a string with system name removed
The function parses the passed name
parameter in search of the first colon (:) character, and returns the substring after it. Typical use case is to cut the system name part from the datapoint name.
Contrary to builtin dpSubStr(), the function may be called for any string, not necessarily being the name of an existing datapoint, It is safe to use with UTF strings.
See also fwGeneral_getNameWithoutSN
name | string from which the system name is to be extracted; |
keepColon | (optional) determines if returned system name should contain the colon character (default: no). |
void fwGeneral_getNameWithoutSN | ( | string | name, |
string & | nameWithoutSN, | ||
dyn_string & | exceptionInfo | ||
) |
Removes the system name from the passed name.
See also
name | name to be processed |
nameWithoutSN | on return will contant name with system name removed |
exceptionInfo | not used (compatibility) |
void fwGeneral_getSystemIpAddress | ( | string | systemName, |
string & | ipAddress, | ||
string & | hostName, | ||
dyn_string & | exceptionInfo | ||
) |
Returns ipAddress and hostName where the PVSS system with name systemName is running.
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 |
void fwGeneral_getSystemName | ( | string | name, |
string & | systemName, | ||
dyn_string & | exceptionInfo | ||
) |
Gets the system name from the passed name.
See also
Note that this function returns the system name with the colon character at the end. Use the fwSysName function with the keepColon=true
parameter to get the name without.
name | name to be processed (e.g. "dist_1:CAEN/crate01/board03/channel005") |
systemName | on return will contain system name extracted from the name parameter; in example above it would yeild "dist_1:" |
exceptionInfo | not used (compatibility) |
bool fwGeneral_hasCorrectDateFormat | ( | string | sDate | ) |
Checks the format of a provided date. Checks for following format: dd/mm/yyyy
Input | - string: date at question |
bool fwGeneral_hasCorrectFormat | ( | string | sDateTime | ) |
Checks the format of a provided date and time. Checks for following format: dd/mm/yyyy hh:mm:ss
Input | - string: date and time at question |
bool fwGeneral_hasCorrectTimeFormat | ( | string | sTime | ) |
Checks the format of a provided time. Checks for following format: hh:mm:ss
Input | - string: time at question |
void fwGeneral_isDpeTypeDyn | ( | int | type, |
bool & | isDyn, | ||
dyn_string & | exceptionInfo | ||
) |
Returns whether the dpe type is dyn or not
type | integer number for dpe type |
isDyn | whether the dpetype is dyn or not |
exceptionInfo | details of any exceptions |
void fwGeneral_openDetailsPanel | ( | string | dpe, |
dyn_string & | exceptionInfo | ||
) |
Opens the details panel for a given datapoint element
dpe | datapoint element to get the details from |
exceptionInfo | details of any exceptions |
void 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.
PVSS manager usage VISION
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 WARNING: deprecated from PVSS 3.6 and higher |
onlyInfo | whether the panel is just for information, or it will also ask for user input |
void 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
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 |
void fwGeneral_setGlobalValue | ( | string | globalVariable, |
anytype | value, | ||
dyn_string & | exceptionInfo | ||
) |
Sets the value of a global variable
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 |
void 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.
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. |
time fwGeneral_stringToDate | ( | string | sDateTime | ) |
Converts previously checked time string into time value.
Input | - string: date and time to be checked |
string fwGeneral_recodeFile | ( | string | fnameToRecode, |
dyn_string & | exceptionInfo | ||
) |
Gets an ISO-8859-1 encoded text file and returns the path of a new text file in UTF-8 encoding.
fnameToRecode,string,filename+path | which needs to be encoded |
void fwGeneral_getQueryRDBdirectEnabled | ( | bool & | queryRDBdirectEnabled | ) |
Gets status of QueryRDBdirect (on, off)
queryRDBdirectEnabled,bool,out,queryRDBdirect | true=on false=off |
void fwGeneral_getParallelArchivingEnabled | ( | bool & | RDBinstalled, |
bool & | parallelArchivingEnabled | ||
) |
Gets status of Parallel archiving (RDB installed + parallel on-off)
RDBinstalled,bool,out,RDB | is installed; true=installed |
parallelArchivingEnabled,bool,out,parallel | Archiving Enabled; true=on false=off |
void fwGeneral_setQueryRDBdirectEnabled | ( | bool | queryRDBdirectEnabled | ) |
set the status of QueryRDBdirect (on, off)
queryRDBdirectEnabled,bool,in,queryRDBdirect | true=on false=off |
string fwGeneral_getFileExtension | ( | string | filePath | ) |
Returns file extension of given file.
filePath,string | (in) Path to a file, may be absoulte or relative. File name is accepted also |
string fwGeneral_removeFileExtension | ( | string | filePath | ) |
Returns file path without file extension.
filePath,string | (in) Path to a file, may be absoulte or relative. File name is accepted also |
void fwGeneral_setHelpUseInternalBrowser | ( | bool | useInternalBrowser, |
dyn_string & | exceptionInfo | ||
) |
Sets in configuration datapoint if internal browser should be used to open help files.
useInternalBrowser,bool | (in) Flag indicating if internal browser should be used to open help files. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
void fwGeneral_getHelpUseInternalBrowser | ( | bool & | useInternalBrowser, |
dyn_string & | exceptionInfo | ||
) |
Retrieves from configuration datapoint if internal built-in browser should be used to open help files.
useInternalBrowser,bool | (out) Flag indicating if internal browser should be used to open help files. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
int fwGeneral_setHelpExtBrowserCommand | ( | string | browserCmdLin, |
string | browserCmdWin, | ||
dyn_string & | exceptionInfo | ||
) |
Sets in configuration datapoint commands used to open external browser on Linux and Windows.
browserCmdLin,string | (in) Command to open external browser on Linux operating systems. |
browserCmdWin,string | (in) Command to open external browser on Windows operating systems. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
int fwGeneral_getHelpExtBrowserCommand | ( | string & | browserCmdLin, |
string & | browserCmdWin, | ||
dyn_string & | exceptionInfo | ||
) |
Retrieves from configuration datapoint commands used to open external browser on Linux and Windows.
browserCmdLin,string | (out) Command to open external browser on Linux operating systems. |
browserCmdWin,string | (out) Command to open external browser on Windows operating systems. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
private void fwGeneral_openHelpFile | ( | string | helpFilePath, |
dyn_string & | exceptionInfo, | ||
string | label = "" , |
||
string | windowName = "fwGeneralHelp" |
||
) |
Opens given help file in defined help file's browser.
helpFilePath,string | (in) Path to the help file. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
label,string | (in, optional) The label of the tab in fwViewer. |
windowName,string | (in, optional) The name of the window in fwViewer (groups tabs together). |
void fwGeneral_openInExternalBrowser | ( | string | url, |
dyn_string & | exceptionInfo | ||
) |
Opens given URL in external browser.
url,string | (in) Address to open in external browser |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
void fwGeneral_openHelpForPanel | ( | string | panelFilePath, |
dyn_string & | exceptionInfo | ||
) |
Opens help file of a given panel file.
panelFilePath,string | (in) Relative path to a panel file (from panels/ directory) |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
void fwGeneral_openHelpForComponent | ( | string | componentName, |
dyn_string & | exceptionInfo | ||
) |
Opens help file of a given component.
componentName,string | (in) Name of a component, note that underscore should be removed from the beggining of a subcomponent name if necessary, before passing it to the function. |
exceptionInfo,dyn_string | (in/out) Details of any exceptions |
void FWDEPRECATED | ( | ) |
Marks a function or a panel as deprecated (reports and records the incident)
|
private |
Clears the log of deprecated function calls
used internally by the fwGeneral/fwDeprecatedList.pnl
private void _fwGeneral_displayDeprecatedLabel | ( | int | x = 0 , |
int | y = 0 |
||
) |
Displays flashing "Deprecated" label at a certain position for a couple of seconds
The function is to be used through startThread() so that it does not block critical setion that may need to be locked.
The x and y param make particular sense for reference panels; they need to be passed from the parent object, otherwise it would not work...
bool fwGeneral_loadCtrlLib | ( | string | libRelPath, |
bool | excOnNotFound = true , |
||
bool | useBeyondInit = false |
||
) |
Load a CTRL library at runtime
Dynamically loads a CTRL library into the running UI or CTRL Manager. Allows for conditional loading of functionality (ie. if library exists). As it uses the startScript(), it could be automatically executed on the library loading (see example below)
if | excOnNotFound set to true, exception raised if library was not found |
if | problem occurs with the library while loading |
if | called not from the lib global initialization without setting the useBeyondInit param |
Example: library A.ctl that conditionally loads B.ctl if it exists
global const dyn_int g_fwGeneral_dynDpeTypes |
constants representing dynamic dpe types