RapidCodeObject Class Reference

The RapidCode base class. All non-error objects are derived from this class. More...

Inherited by IO, IOPoint, RapidCodeInterrupt, and RapidCodeSqNode.

List of all members.

Errors and Exceptions



long ErrorLogCountGet ()
 Get the number of software errors in the error log.
RsiErrorErrorLogGet ()
 Get the next RsiError in the log.
void ErrorLogClear ()
 Clear the error log.
char * RsiErrorMessageGet (RSIErrorMessage msg)
char * ErrorMessageGet (RSIErrorMessage msg)
void ErrorMsgCheck (RapidCodeObject *object, RSIErrorMessage msg, const char *function, long line)
void ErrorMsgCheck (RapidCodeObject *object, RSIErrorMessage msg, const char *text, const char *function, long line)

Exceptions Enabled



void ThrowExceptions (bool state)
 Configure a class to throw exceptions.

RapidCode Version



char * VersionGet ()
 Get the RSI RapidCode version.

Detailed Description

The RapidCodeObject class contains the Error Log and access functions. Storing up to 100 RsiError items, RapidCodeObject makes them available to you with the ErrorLogGet function. ErrorLogCountGet returns the number of unread errors and should be greater than 0 when using ErrorLogGet. Each ErrorLogGet call returns a single unread RsiError per call. RapidCodeObject also provides the RSI and SynqNet Version information.

Examples:

errorLog.cpp, and SynqNetOk.cpp.


The documentation for this class was generated from the following files: