|
The RMP Motion Controller APIs
|
|
|
The RMP Motion Controller APIs
|
The RapidCode base class. All non-error objects are derived from this class. More...
Functions | |
| const char *const | VersionGet () |
| Get the RSI RapidCode version. | |
| int32_t | MpiVersionMajor () |
| Get the major MPI version. | |
| int32_t | MpiVersionMinor () |
| Get the minor MPI version. | |
| int32_t | MpiVersionRelease () |
| Get the release MPI version. | |
| int32_t | RSIVersionMajor () |
| Get the major RSI version. | |
| int32_t | RSIVersionMinor () |
| Get the minor RSI version. | |
| int32_t | RSIVersionMicro () |
| Get the micro RSI version. | |
| int32_t | RSIVersionPatch () |
| Get the patch RSI version. | |
| int32_t | NumberGet () |
| Get the zero-based index of this object. | |
| int32_t | ErrorLogCountGet () |
| Get the number of software errors in the error log. | |
| const RsiError *const | ErrorLogGet () |
| Get the next RsiError in the log. | |
| void | ErrorLogClear () |
| Clear the error log. | |
| void | ThrowExceptions (bool state) |
| Configure a class to throw exceptions. | |
| const char *const | RsiErrorMessageGet (RSIErrorMessage msg) |
| Get the RSI-specific error message text for a specific RSIErrorMessage. | |
| const char *const | ErrorMessageGet (RSIErrorMessage msg) |
| Get the detailed text message for an RSIErrorMessage. | |
| bool | WarningMsgCheck (RSIErrorMessage msg) |
| Check to see if an RSIErrorMessage is a warning (true) or not (false). | |
| void | Trace (bool state) |
| Enables/Disables trace output. | |
| void | TraceMaskOnSet (RSITrace maskOn) |
| Turn on a particular trace output mask. | |
| bool | TraceMaskOnGet (RSITrace maskOn) |
| Check to see if a particular trace output mask is turned on. | |
| void | TraceMaskOffSet (RSITrace maskOff) |
| Turn off a particular trace output mask. | |
| void | TraceMaskClear () |
| Clear the trace output mask. | |
| void | TraceFileSet (const char *const fileName) |
| Channels Tracing messages to specified file. | |
| void | TraceFileClose () |
| Stops Logging to the file. | |
| void | TraceInjectMessage (RSITrace traceLevel, const char *const message) |
| Add a message to the Trace Log. | |
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 version information.
1.10.0