The RMP Motion Controller APIs
IOPoint

The IOPoint object represents one specific point class such as: Digital Output, Digital Input, Analog Output, or Analog Input. More...

Static Functions

static IOPointCreateDigitalInput (Axis *axis, RSIMotorDedicatedIn motorDedicatedInNumber)
 Create a Digital Input from an Axis' Dedicated Input bits. More...
 
static IOPointCreateDigitalInput (Axis *axis, RSIMotorGeneralIo motorGeneralIoNumber)
 Create a Digital Input from an Axis' general purpose inputs. More...
 
static IOPointCreateDigitalInput (IO *io, int32_t bitNumber)
 Create a Digital Input from an I/O Node. More...
 
static IOPointCreateDigitalInput (MotionController *controller, int32_t pdoIndex, int32_t bitNumber, RSIPDOType type)
 Create a Digital Output from a network PDO. More...
 
static IOPointCreateDigitalInput (MotionController *controller, uint64_t memoryAddress, int32_t bitNumber)
 Create a Digital Output from a network PDO. More...
 
static IOPointCreateDigitalOutput (Axis *axis, RSIMotorDedicatedOut motorDedicatedOutNumber)
 Create a Digital Output from an Axis' Dedicated Output bits. More...
 
static IOPointCreateDigitalOutput (Axis *axis, RSIMotorGeneralIo motorGeneralIoNumber)
 Create a Digital Output from an Axis' general purpose inputs. More...
 
static IOPointCreateDigitalOutput (IO *io, int32_t bitNumber)
 Create a Digital Output from an I/O Node. More...
 
static IOPointCreateDigitalOutput (MotionController *controller, int32_t pdoIndex, int32_t bitNumber, RSIPDOType type)
 Create a Digital Output from a network PDO. More...
 
static IOPointCreateDigitalOutput (MotionController *controller, uint64_t memoryAddress, int32_t bitNumber)
 Create a Digital Output from a network PDO. More...
 
static IOPointCreateAnalogInput (IO *io, int32_t analogChannel)
 Create an Analog Input from an I/O Node. More...
 
static IOPointCreateAnalogOutput (IO *io, int32_t analogChannel)
 Create an Analog Output from an I/O Node. More...
 

Functions

uint64_t AddressGet ()
 Get the Host Address for the I/O point. More...
 
int32_t MaskGet ()
 Get the bit mask for the I/O point. More...
 
bool IsDigital ()
 Determine if an I/O point is Digital or Analog. More...
 
bool IsOutput ()
 Determine if an I/O point is an output. More...
 
bool Get ()
 Get the state of Digital Input or Output. More...
 
void Set (bool state)
 Set the state of a Digital Output. More...
 
double ValueGet ()
 Get the value of an Analog Input or Output. More...
 
void ValueSet (double valueDouble)
 Set the value for an Analog Output. More...
 
const char *const VersionGet ()
 Get the RSI RapidCode version. More...
 
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. More...
 
int32_t ErrorLogCountGet ()
 Get the number of software errors in the error log. More...
 
const RsiError *const ErrorLogGet ()
 Get the next RsiError in the log. More...
 
void ErrorLogClear ()
 Clear the error log. More...
 
void ThrowExceptions (bool state)
 Configure a class to throw exceptions. More...
 
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. More...
 
void TraceMaskOnSet (RSITrace maskOn)
 Turn on a particular trace output mask. More...
 
bool TraceMaskOnGet (RSITrace maskOn)
 Check to see if a particular trace output mask is turned on. More...
 
void TraceMaskOffSet (RSITrace maskOff)
 Turn off a particular trace output mask. More...
 
void TraceMaskClear ()
 Clear the trace output mask. More...
 
void TraceFileSet (const char *const fileName)
 Channels Tracing messages to specified file. More...
 
void TraceFileClose ()
 Stops Logging to the file. More...
 
void TraceInjectMessage (RSITrace traceLevel, const char *const message)
 Add a message to the Trace Log. More...
 

Description


The IOPoint object will be automatically deleted when the MotionController object is deleted.

Examples
SingleAxisSyncOutputs.cpp, SyncOutputWithMotion.cpp, and UserLimitDigitalInputAction.cpp.

Definition at line 11813 of file rsi.h.