fwGeneral.ctl File Reference
const string fwGeneral_DYN_STRING_DEFAULT_SEPARATOR = "|"
 
const string FW_GENERAL_NATURAL_TIME_FORMAT = "%d/%m/%Y - %H:%M:%S"
 
const string FW_GENERAL_GENERIC_TIME_FORMAT = "%Y.%m.%d %H:%M:%S"
 
const string FW_GENERAL_TIMEZONE_UTC = "UTC"
 
const string FW_GENERAL_TIMEZONE_LOCAL = "LOCAL"
 
global dyn_int g_fwGeneral_dynDpeTypes
 
 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)
 
 fwGeneral_dateTimeWidget_setEnabled (bool bState)
 
public bool fwGeneral_dateTimeWidget_isEnabled ()
 
 fwGeneral_dateTimeWidget_setEndDateTime (time tDateTime)
 
 fwGeneral_dateTimeWidget_setStartDateTime (time tDateTime)
 
 fwGeneral_dateTimeWidget_setTimeZone (string sTimeZone)
 
 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_fillDynString (dyn_string &ds, int length, dyn_string &exceptionInfo, string value="")
 
 fwGeneral_getDpElements (string dp, string dpType, dyn_string &dpElements, dyn_string &dpElementTypes, dyn_string &exceptionInfo, dyn_int excludedTypes="", bool forceDpCreation=false)
 
 fwGeneral_getDynDpeTypes (dyn_string &dynTypes, dyn_string &exceptionInfo)
 
 fwGeneral_getGlobalValue (string globalVariable, anytype &value, dyn_string &exceptionInfo)
 
 fwGeneral_getNameWithoutSN (string name, string &nameWithoutSN, dyn_string &exceptionInfo)
 
 fwGeneral_getSystemIpAddress (string systemName, string &ipAddress, string &hostName, dyn_string &exceptionInfo)
 
 fwGeneral_getSystemName (string name, string &systemName, dyn_string &exceptionInfo)
 
bool fwGeneral_hasCorrectDateFormat (string sDate)
 
 fwGeneral_openInExternalBrowser (string sLink, dyn_string &exceptionInfo)
 
bool fwGeneral_hasCorrectFormat (string sDateTime)
 
bool fwGeneral_hasCorrectTimeFormat (string sTime)
 
 fwGeneral_init (dyn_string &exceptionInfo)
 
 fwGeneral_isDpeTypeDyn (int type, bool &isDyn, dyn_string &exceptionInfo)
 
 fwGeneral_openDetailsPanel (string dpe, dyn_string &exceptionInfo)
 
 fwGeneral_openMessagePanel (string message, bool &ok, dyn_string &exceptionInfo, string panelBarTitle="", bool onlyInfo=FALSE)
 
 fwGeneral_selectFromList (dyn_string list, dyn_string &selection, dyn_string &exceptionInfo, bool multipleSelection=false, string title="Select fromt the list")
 
 fwGeneral_setGlobalValue (string globalVariable, anytype value, dyn_string &exceptionInfo)
 
 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)
 
 fwGeneral_getQueryRDBdirectEnabled (bool &queryRDBdirectEnabled)
 
 fwGeneral_getParallelArchivingEnabled (bool &RDBinstalled, bool &parallelArchivingEnabled)
 
 fwGeneral_setQueryRDBdirectEnabled (bool queryRDBdirectEnabled)
 

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
dpename of the datapoint where the command will be applied
commandshort explanation of the action to be confirmed
confirmationwhether the user confirmed the command or not
exceptionInforeturns 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.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • endDateField
  • endTimeField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bOkOutput - 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
Returns
End date as time value

References fwGeneral_hasCorrectFormat(), and fwGeneral_stringToDate().

time fwGeneral_dateTimeWidget_getStartDateTime ( bool &  bOk,
dyn_string &  dsException 
)
Returns start date and time selected by the user and performs format check.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • startDateField
  • startTimeField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bOkOutput - 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
Returns
Start date as time value

References fwGeneral_hasCorrectFormat(), and fwGeneral_stringToDate().

string fwGeneral_dateTimeWidget_getTimeZone ( )
Returns the time zone used to determine the current time.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • selectedTimeZone
Usage
Public
PVSS managers
VISION, CTRL
Returns
Time zone as string
public bool fwGeneral_dateTimeWidget_isEnabled ( )

Is the DateTime widget enabled?

Returns
bool
bool fwGeneral_dateTimeWidget_positivePeriodSelected ( dyn_string &  dsException)
Checks whether the user has selected a positive time interval in the date/time widget or not.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • startDateField
  • startTimeField
  • endDateField
  • endTimeField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsException- Input/Output: Carrier for exception message to be shown to user
Returns
Boolean value TRUE if positive, FALSE if negative time interval

References fwGeneral_hasCorrectFormat(), and fwGeneral_stringToDate().

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)
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • startNowButton
  • startDateField
  • startTimeField
  • startTimeSpin
  • startDateChooserButton
  • startDateButton
  • endNowButton
  • endDateField
  • endTimeField
  • endTimeSpin
  • endDateChooserButton
  • endDateButton
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bStateInput - boolean: state
fwGeneral_dateTimeWidget_setEndDateTime ( time  tDateTime)
Sets the end date and time in the Date Time Widget.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • endDateField
  • endTimeField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- time: date and time
fwGeneral_dateTimeWidget_setStartDateTime ( time  tDateTime)
Sets the start date and time in the Date Time Widget.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • startDateField
  • startTimeField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- time: date and time
fwGeneral_dateTimeWidget_setTimeZone ( string  sTimeZone)
Sets the time zone used to determine the current time.
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • selectedTimeZone
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- string: time zone (e.g. FW_GENERAL_NATURAL_TIME_FORMAT, FW_GENERAL_GENERIC_TIME_FORMAT)
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. !!!
Constraints
To be used together with date/time widget (fwGeneralDateTimeWidget.pnl). The following UI elements have to be existent:
  • startNowButton
  • startDateField
  • startTimeField
  • startTimeSpin
  • startDateChooserButton
  • startDateButton
  • endNowButton
  • endDateField
  • endTimeField
  • endTimeSpin
  • endDateChooserButton
  • endDateButton
  • startTimeLabel
  • endTimeLabel
  • timeZoneLabel
  • selectedTimeZone
  • dateTimeSeparator
  • dateAndTimeShownField
  • timeZoneShownField
Usage
Public
PVSS managers
VISION, CTRL
Parameters
bStateInput - 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

Constraints
None
Usage
Public
PVSS maangers
VISION
Parameters
selectedDpTypesreturns the list of selected DP Types (one or multiple, depending on selectMultiple parameter. If specified as input it can contain the pre-defined selection.
disabledDpTypeslist of DP Types that are disabled in the selection list. Specifying empty list means that all items are selectable
exceptionInforeturns details of any errors
selectMultipledetermines if the selection list allows for multiple selection, or single selection only.
textpanel title. If an empty string is specified, then "Select Datapoint Types" will be used.
void 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
theDynStringdyn_string to be converted
theStringresult of the conversion
separatorseparator 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 = "" 
)
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.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsthe dynamic string to be modified
lengthminimum length required for the dynamic string
exceptionInforeturns details of any exceptions
valuevalue 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 = "",
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.

Constraints
If a dp type is specified , at least one datapoint of the type has to exist
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dpdatapoint to get the elements from
dpTypedp type to get the elements from if no datapoint was specified (dp = "")
dpElementsreturns the list of dp elements sorted into alphabetical order. NB Their name(s) begin with "." !
dpElementTypesreturns the list of types of corresponding to the list of dp elements
exceptionInforeturns details of any exceptions
excludedTypesexcluded dp elements of these types from the list
forceDpCreationif 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

References fwException_raise(), and fwGeneral_getSystemName().

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
dynTypeslist of integer values of dynamic dpe types (does not dyn_anytype or any dyn_dyn)
exceptionInfodetails of any exceptions

Referenced by fwGeneral_init().

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
globalVariablename of the global variable to get the value from
valuereturns the value of the global variable
exceptionInfodetails 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
namename to be processed
nameWithoutSNname with system name removed
exceptionInfodetails of any exceptions
fwGeneral_getParallelArchivingEnabled ( bool &  RDBinstalled,
bool &  parallelArchivingEnabled 
)
Gets status of Parallel archiving (RDB installed + parallel on-off)
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
RDBinstalled,bool,out,RDBis installed; true=installed
parallelArchivingEnabled,bool,out,parallelArchiving Enabled; true=on false=off
fwGeneral_getQueryRDBdirectEnabled ( bool &  queryRDBdirectEnabled)
Gets status of QueryRDBdirect (on, off)
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
queryRDBdirectEnabled,bool,out,queryRDBdirecttrue=on false=off
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
systemNamename of the system we are interested in
ipAddressip address of the machine where the PVSS system is running
hostNamehost name of the machine where the PVSS system is running
exceptionInforeturns details of any exceptions

References fwException_raise().

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
namename to be processed (e.g. system1:crate01/board03/channel005)
systemNamesystem name extracted from name (e.g. system1:)
exceptionInfodetails of any exceptions

Referenced by fwGeneral_getDpElements().

bool fwGeneral_hasCorrectDateFormat ( string  sDate)
Checks the format of a provided date. Checks for following format: dd/mm/yyyy
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- string: date at question
Returns
Boolean value indicating result of check

Referenced by fwGeneral_hasCorrectFormat().

bool fwGeneral_hasCorrectFormat ( string  sDateTime)
Checks the format of a provided date and time. Checks for following format: dd/mm/yyyy hh:mm:ss
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- string: date and time at question
Returns
Boolean value indicating result of check

References fwGeneral_hasCorrectDateFormat(), and fwGeneral_hasCorrectTimeFormat().

Referenced by fwGeneral_dateTimeWidget_getEndDateTime(), fwGeneral_dateTimeWidget_getStartDateTime(), and fwGeneral_dateTimeWidget_positivePeriodSelected().

bool fwGeneral_hasCorrectTimeFormat ( string  sTime)
Checks the format of a provided time. Checks for following format: hh:mm:ss
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
Input- string: time at question
Returns
Boolean value indicating result of check

Referenced by fwGeneral_hasCorrectFormat().

fwGeneral_init ( dyn_string &  exceptionInfo)
Initializes global constants provided by the library
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
exceptionInfodetails of any exceptions

References fwGeneral_getDynDpeTypes().

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
typeinteger number for dpe type
isDynwhether the dpetype is dyn or not
exceptionInfodetails 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
dpedatapoint element to get the details from
exceptionInfodetails of any exceptions
fwGeneral_openInExternalBrowser ( string  sLink,
dyn_string &  exceptionInfo 
)
Open the www link in default browser
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
sLinkstring www link
exceptionInfodetails of any exceptions

References fwException_raise(), and fwExceptionHandling_display().

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
messagethe message to be presented in the panel
okreturns TRUE if the user pressed the Ok button, FALSE otherwise
exceptionInfodetails of any exceptions
panelBarTitletitle for the panel WARNING: deprecated from PVSS 3.6 and higher
onlyInfowhether the panel is just for information, or it will also ask for user input
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.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
fnameToRecode,string,filename+pathwhich needs to be encoded
Returns
string path+filename of the encoded file.

References fwException_raise().

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
listlist of strings to select from
selectionreturns the selected items
exceptionInfodetails of any exceptions
multipleSelectionwhether it is possible to select more than one item or not
titletitle 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
globalVariablename of the global variable to set the value to
valuethe value to be set to the global variable
exceptionInfodetails of any exceptions
fwGeneral_setQueryRDBdirectEnabled ( bool  queryRDBdirectEnabled)
set the status of QueryRDBdirect (on, off)
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
queryRDBdirectEnabled,bool,in,queryRDBdirecttrue=on false=off
time fwGeneral_stringToDate ( string  sDateTime)
Converts previously checked time string into time value.
Constraints
None
Usage
Public
WinCC managers
VISION, CTRL
Parameters
Input- string: date and time to be checked
Returns
Time value of string including milliseconds (1970.01.01 00:00:00 in case of bad format)

Referenced by fwGeneral_dateTimeWidget_getEndDateTime(), fwGeneral_dateTimeWidget_getStartDateTime(), and fwGeneral_dateTimeWidget_positivePeriodSelected().

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
theStringstring to be split
theDynStringresult of splitting
separatorseparator used for splitting. The default value should be fwGeneral_DYN_STRING_DEFAULT_SEPARATOR, but PVSS doesn't allow constants in default arguments
removeSpaceswhether to remove spaces in the string before parsing it or not
compatibilityModeuseful 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.