 |
MotionController | Axis | MultiAxis | IO | IOPoint | NetworkNode | RsiError | Sample Apps | Changelog |
RapidCode API |
|
Interface for objects which can use interrupts. More...
Functions | |
Interrupts | |
| virtual void | InterruptEnableSet (bool enable)=0 |
| Enable or disable interrupts. | |
| virtual RSIEventType | InterruptWait (int32 milliseconds)=0 |
| Suspend the current thread until an interrupt arrives from the controller. More... | |
| virtual char * | InterruptNameGet ()=0 |
| Get the text name of an interrupt type. More... | |
| virtual int32 | InterruptSampleTimeGet ()=0 |
| Get the sample timer value when the last interrupt was generated. More... | |
| virtual int32 | InterruptSourceNumberGet ()=0 |
| Get the number (or index) of the object (Axis, Motor, etc) that generated the interrupt. More... | |
| virtual uint16 | InterruptMotionIdGet ()=0 |
| Get the 16-bit MotionId - only valid if RSIEventType == MOTION_DONE. | |
| virtual void | InterruptWake ()=0 |
| Wake any and all threads waiting for interrupts. | |
| virtual void | InterruptMaskClear ()=0 |
| Clear the interrupt mask so no interrupts will be generated. | |
| virtual void | InterruptMaskAllSet ()=0 |
| Set all the bits of the interrupt mask to get interrupts for ALL sources. | |
| virtual void | InterruptMaskOnSet (RSIEventType eventType)=0 |
| Set a bit in the interrupt mask so you will get interrupts for the given RSIEventType. | |
| virtual void | InterruptMaskOffSet (RSIEventType eventType)=0 |
| Clear a bit in the interrupt mask so you won't get interrupts for the given RSIEventType. | |
| virtual bool | InterruptMaskOnGet (RSIEventType eventType)=0 |
| Get the status of the interrupt mask for the given RSIEventType. | |
| virtual uint64 | InterruptUserDataGet (uint32 index)=0 |
| Get the user data associated with the interrupt. More... | |
Version | |
| virtual char * | VersionGet ()=0 |
| Get the RSI RapidCode version. More... | |
| virtual int32 | MpiVersionMajor ()=0 |
| Get the major version number of the MPI library. | |
| virtual int32 | MpiVersionMinor ()=0 |
| Get the minor version number of the MPI library. | |
| virtual int32 | MpiVersionRelease ()=0 |
| Get the release version number of the MPI library. | |
| virtual int32 | RSIVersionMajor ()=0 |
| Get the major version number of the RSI library. | |
| virtual int32 | RSIVersionMinor ()=0 |
| Get the minor version number of the RSI library. | |
| virtual int32 | RSIVersionMicro ()=0 |
| Get the micro version number of the RSI library. | |
| virtual int32 | NumberGet ()=0 |
| Get the zero-based index of this object. More... | |
Errors and Exceptions | |
| virtual int32 | ErrorLogCountGet ()=0 |
| Get the number of software errors in the error log. More... | |
| virtual RsiError * | ErrorLogGet ()=0 |
| Get the next RsiError in the log. More... | |
| virtual void | ErrorLogClear ()=0 |
| Clear the error log. More... | |
| virtual void | ThrowExceptions (bool state)=0 |
| Configure a class to throw exceptions. More... | |
| virtual void | CacheEnableSet (RSICacheObject cache, bool enable, uint32 expirationMilliseconds)=0 |
| Configure a class to cache data for specified time. More... | |
| virtual char * | RsiErrorMessageGet (RSIErrorMessage msg)=0 |
| Get the RSI-specific error message text for a specific RSIErrorMessage. | |
| virtual char * | ErrorMessageGet (RSIErrorMessage msg)=0 |
| Get the detailed text message for an RSIErrorMessage. | |
| virtual bool | WarningMsgCheck (RSIErrorMessage msg)=0 |
| Check to see if an RSIErrorMessage is a warning (true) or not (false). | |
Tracing | |
| virtual void | Trace (bool state)=0 |
| Enables/Disables trace output. More... | |
| virtual void | TraceMaskOnSet (RSITrace maskOn)=0 |
| Turn on a particular trace output mask. More... | |
| virtual bool | TraceMaskOnGet (RSITrace maskOn)=0 |
| Check to see if a particular trace output mask is turned on. More... | |
| virtual void | TraceMaskOffSet (RSITrace maskOff)=0 |
| Turn off a particular trace output mask. More... | |
| virtual void | TraceMaskClear ()=0 |
| Clear the trace output mask. More... | |
| virtual void | TraceFileSet (const char *fileName)=0 |
| Channels Tracing messages to specified file. More... | |
| virtual void | TraceFileClose ()=0 |
| Stops Logging to the file. More... | |
| virtual void | TraceInjectMessage (RSITrace traceLevel, const char *msg)=0 |
| Add a message to the Trace Log. More... | |
Interface for objects which can use interrupts.