IO Class Reference
The SynqNet I/O node class. To access any SynqNet I/O point in a general way, see IOPoint.
IO objects have access to RapidCodeSqNode functions by ioName->SqNode->sqFunctionName.
More...
Inherits RapidCodeObject.
Friends | |
| class | MotionController |
Configuration and Info | |
|
| |
| bool | IOExists () |
| IOExists validates your IO object is an IO Node. | |
Initialize | |
|
| |
| char * | UserLabelGet () |
| void | UserLabelSet (char *userLabel) |
I/O | |
|
| |
| void | WaitFlagSet (bool flag) |
| bool | WaitFlagGet () |
| bool | DigitalInGet (long digitalInNumber) |
| Get the state of a digital input bit. | |
| bool | DigitalOutGet (long digitalOutNumber) |
| Get the state of a Digital Output bit. | |
| void | DigitalOutSet (long digitalOutNumber, bool value) |
| Set the state of a digital output bit. | |
| long | DigitalInGet (long startBitNumber, long bitCount) |
| Get the state of multiple digital input bits. | |
| long | DigitalOutGet (long startBitNumber, long bitCount) |
| Get the state of multiple digital output bits. | |
| void | DigitalOutSet (long startBitNumber, long bitCount, long value) |
| Set the state of multiple digital output bits. | |
| long | AnalogInGet (long analogChannel) |
| Get the value of an analog input. | |
| long | AnalogOutGet (long analogChannel) |
| Get the value of an analog input. | |
| void | AnalogOutSet (long analogChannel, long value) |
| Set the value of an analog input. | |
| long | SegmentDigitalInGet (long segmentNumber, long startBitNumber, long bitCount) |
| Get the state of a segment's digital input bits. | |
| long | SegmentDigitalOutGet (long segmentNumber, long startBitNumber, long bitCount) |
| Get the state of a segment's digital output bits. | |
| void | SegmentDigitalOutSet (long segmentNumber, long startBitNumber, long bitCount, long value) |
| Set the state of a segment's digital output bits. | |
| bool | SegmentDigitalInGet (long segmentNumber, long bitNumber) |
| Get the state of a segment's digital input bit. | |
| bool | SegmentDigitalOutGet (long segmentNumber, long bitNumber) |
| Get the state of a segment's digital output bit. | |
| void | SegmentDigitalOutSet (long segmentNumber, long bitNumber, bool value) |
| Set the state of a segment's digital output bit. | |
| long | SegmentAnalogInGet (long segmentNumber, long analogChannel) |
| Get the value of a segment's analog input. | |
| long | SegmentAnalogOutGet (long segmentNumber, long analogChannel) |
| Get the value of a segment's analog input. | |
| void | SegmentAnalogOutSet (long segmentNumber, long analogChannel, long value) |
| Set the value of a segment's analog input. | |
Segment Info | |
|
| |
| long | SegmentDigitalInCountGet (long segmentNumber) |
| Get the number of digital input bits on a segment. | |
| long | SegmentDigitalOutCountGet (long segmentNumber) |
| Get the number of digital output bits on a segment. | |
| long | SegmentAnalogInCountGet (long segmentNumber) |
| Get the number of analog inputs on a segment. | |
| long | SegmentAnalogOutCountGet (long segmentNumber) |
| Get the number of analog outputs on a segment. | |
| long | SegmentParameterCountGet (long segmentNumber) |
| long | SegmentMemoryCountGet (long segmentNumber) |
| long | SegmentVersionGet (long segmentNumber) |
| long | SegmentIDGet (long segmentNumber) |
| long | SegmentOptionGet (long segmentNumber) |
| char * | SegmentSerialNumberGet (long segmentNumber) |
| char * | SegmentModelNameGet (long segmentNumber) |
| char * | SegmentMemoryGet (long segmentNumber, long memoryStart, long memoryCount) |
| void | SegmentMemorySet (long segmentNumber, long memoryStart, long memoryCount, char *data) |
| char * | SegmentParameterGet (long segmentNumber, long parameterStart, long parameterCount) |
| void | SegmentParameterSet (long segmentNumber, long parameterStart, long parameterCount, char *parameters) |
| void | SegmentParameterDefaultsSet () |
| void | SegmentParameterStore () |
| void | SegmentParameterClear () |
Errors and Exceptions | |
|
| |
| long | ErrorLogCountGet () |
| Get the number of software errors in the error log. | |
| RsiError * | ErrorLogGet () |
| 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
You are not required to setup an IO object for all systems. Dedicated io is often used through the Axis class. The IO class is specifically targeting non-axis IO Nodes.
To initalize your io:
/// ioName = controller->IOGet(IO_NODE_NUMBER);
The following shows RapidSetup io usage. You can easily do most of the following using RapidCode.
IO as seen in the RapidSetup utility
- Examples:
-
PVTTriggerIO.cs, SliceCounter.cs, SliceIO.cs, SlicePWM.cs, template.cpp, and userLimitDigitalInputAction.cpp.
The documentation for this class was generated from the following files:
- rsi.h
- rsi.cpp