Functions | Variables
fwException.ctl File Reference

Functions

public errClass fwException_declare (string name, errClass parent=BASE_EXCEPTION)
 
public void fwException_throw (errClass exceptionClass, string exceptionNote="")
 
public void fwException_rethrow ()
 
public void fwException_throwLastError ()
 
public bool fwException_match (string patternClassMatch, errClass ex=fwException_get())
 
public errClass fwException_get ()
 
public string fwException_getClass (errClass ex=fwException_get())
 
public string fwException_getText (errClass ex=fwException_get())
 
public dyn_string fwException_getStackTrace (errClass ex=fwException_get())
 
private errClass _fwException_make (errClass exceptionClass, string exceptionNote)
 
private errClass _fwException_makeFrom (errClass originalEx)
 
private void _fwException_readCatalog ()
 
private void _fwException_addErrorToCatalog (int error_code, string error_name)
 
 fwException_raise (dyn_string &exceptionInfo, string exceptionType, string exceptionText, string exceptionCode)
 
 _fwException_initialise ()
 
 _fwException_writeToPvssLog (dyn_string &exceptionInfo)
 

Variables

public global time _fwException_last_read_catalog = (time) 0
 
private global mapping _fwException_catalog_content
 
private global int _fwException_last_error_code = 0
 
const errClass BASE_EXCEPTION = makeError("fwException", PRIO_SEVERE, ERR_CONTROL, 1, "EX")
 
const errClass BUILTIN_EXCEPTION = fwException_declare("EX.WCCOA")
 
const errClass FWEXCEPTION_SETUP_EXCEPTION = fwException_declare("FWEXCEPTION.SETUP")
 
const errClass INDEX_OUT_OF_RANGE_EXCEPTION = fwException_declare("-79", BUILTIN_EXCEPTION)
 
const errClass DIVISION_BY_ZERO_EXCEPTION = fwException_declare("-80", BUILTIN_EXCEPTION)
 
const string fwException_SETTINGS_DP = "_fwException"
 

Detailed Description

A library including the necessary functions to raise exceptions

Creation Date
4/12/00
Modification Date
02/07/15 - Axel Voitier
Author
JCOP Framework Team

Function Documentation

fwException_raise ( dyn_string &  exceptionInfo,
string  exceptionType,
string  exceptionText,
string  exceptionCode 
)
Add the exception to the PVSS log in the form
    [exceptionType][exceptionText][Code: exceptionCode]

Also the exception details are appended to the dyn_string which is passed to the function
Three strings are appended to the dyn_string, firstly the exceptionType then the exceptionText
and finally a code which is associated with the exception (exceptionCode)
Usage
Public
PVSS managers
VISION, CTRL
Parameters
exceptionInfodetails of exceptions are returned here
exceptionTypetype of exception
exceptionTexttext associated with exception
exceptionCodea code associated with the exception

Referenced by _fwScreenShot_getTemporaryFileName(), _fwScreenShot_takeScreenShotToFile(), _fwScreenShot_takeTableContentToFile(), fwColour_connectItemBackColToStatus(), fwColourTable_connectCellBackColToStatus(), fwColourTable_connectCellBackColToValueStatus(), fwGeneral_getDpElements(), fwGeneral_getSystemIpAddress(), fwGeneral_openInExternalBrowser(), fwGeneral_recodeFile(), fwManager_checkDriverRunning(), fwManager_getScriptsRunByCtrlMan(), fwScreenShot_exportTableContentUserMenu(), fwScreenShot_saveScreenShotToFile(), fwScreenShot_saveTableContentToFile(), fwScreenShot_sendScreenShotByEmail(), fwScreenShot_sendTableContentByEmail(), and fwWebBrowser_showStandaloneWindow().