|
The RMP Motion Controller APIs
|
|
|
The RMP Motion Controller APIs
|
Represents one specific point: Digital Output, Digital Input, Analog Output, or Analog Input. This class provides a helper interface to any I/O, regardless of where it resides: MotionController, Axis, or NetworkNode. To create an IOPoint, use IOPoint Creation Methods. More...
Static Functions | |
| static IOPoint * | CreateDigitalInput (Axis *axis, RSIMotorDedicatedIn motorDedicatedInNumber) |
| Create a Digital Input from an Axis' Dedicated Input bits. | |
| static IOPoint * | CreateDigitalInput (Axis *axis, RSIMotorGeneralIo motorGeneralIoNumber) |
| Create a Digital Input from an Axis' general purpose inputs. | |
| static IOPoint * | CreateDigitalInput (NetworkNode *networkNode, int32_t bitNumber) |
| Create a Digital Input from a RapidCodeNetworkNode. | |
| static IOPoint * | CreateDigitalInput (MotionController *controller, int32_t pdoIndex, int32_t bitNumber, RSIPDOType type) |
| Create a Digital Output from a network PDO. | |
| static IOPoint * | CreateDigitalInput (MotionController *controller, uint64_t memoryAddress, int32_t bitNumber) |
| Create a Digital Output from a network PDO. | |
| static IOPoint * | CreateDigitalOutput (Axis *axis, RSIMotorDedicatedOut motorDedicatedOutNumber) |
| Create a Digital Output from an Axis' Dedicated Output bits. | |
| static IOPoint * | CreateDigitalOutput (Axis *axis, RSIMotorGeneralIo motorGeneralIoNumber) |
| Create a Digital Output from an Axis' general purpose inputs. | |
| static IOPoint * | CreateDigitalOutput (NetworkNode *networkNode, int32_t bitNumber) |
| Create a Digital Output from a RapidCodeNetworkNode. | |
| static IOPoint * | CreateDigitalOutput (MotionController *controller, int32_t pdoIndex, int32_t bitNumber, RSIPDOType type) |
| Create a Digital Output from a network PDO. | |
| static IOPoint * | CreateDigitalOutput (MotionController *controller, uint64_t memoryAddress, int32_t bitNumber) |
| Create a Digital Output from a network PDO. | |
| static IOPoint * | CreateAnalogInput (NetworkNode *networkNode, int32_t analogChannel) |
| Create an Analog Input from a RapidCodeNetworkNode. | |
| static IOPoint * | CreateAnalogOutput (NetworkNode *networkNode, int32_t analogChannel) |
| Create an Analog Output from a RapidCodeNetworkNode. | |
Functions | |
| uint64_t | AddressGet () |
| Get the Host Address for the I/O point. | |
| int32_t | MaskGet () |
| Get the bit mask for the I/O point. | |
| bool | IsDigital () |
| Determine if an I/O point is Digital or Analog. | |
| bool | IsOutput () |
| Determine if an I/O point is an output. | |
| bool | Get () |
| Get the state of Digital Input or Output. | |
| void | Set (bool state) |
| Set the state of a Digital Output. | |
| double | ValueGet () |
| Get the value of an Analog Input or Output. | |
| void | ValueSet (double valueDouble) |
| Set the value for an Analog Output. | |
| 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 IOPoint objects will all be automatically deleted when the MotionController object is deleted.
1.10.0