MotionController Axis MultiAxis IO IOPoint NetworkNode RsiError
Sample Apps Changelog

RapidCode API

IOPointabstract

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

Static Functions

Creation Methods
static IOPointCreateDigitalInput (Axis *axis, RSIMotorDedicatedIn bitNumber)
 Create a Digital Input from an Axis' Dedicated Input bits. More...
 
static IOPointCreateDigitalInput (Axis *axis, RSIMotorGeneralIo bitNumber)
 Create a Digital Input from an Axis' general purpose inputs. More...
 
static IOPointCreateDigitalInput (IO *io, int32 bitNumber)
 Create a Digital Input from an I/O Node. More...
 
static IOPointCreateDigitalOutput (Axis *axis, RSIMotorDedicatedOut bitNumber)
 Create a Digital Output from an Axis' Dedicated Output bits. More...
 
static IOPointCreateDigitalOutput (Axis *axis, RSIMotorGeneralIo bitNumber)
 Create a Digital Output from an Axis' general purpose inputs. More...
 
static IOPointCreateDigitalOutput (IO *io, int32 bitNumber)
 Create a Digital Output from an I/O Node. More...
 
static IOPointCreateAnalogInput (IO *io, int32 analogChannel)
 Create an Analog Input from an I/O Node. More...
 
static IOPointCreateAnalogOutput (IO *io, int32 analogChannel)
 Create an Analog Output from an I/O Node. More...
 

Functions

Information
virtual uint64 AddressGet ()=0
 Get the Host Address for the I/O point. More...
 
virtual int32 MaskGet ()=0
 Get the bit mask for the I/O point. More...
 
virtual bool IsDigital ()=0
 Determine if an I/O point is Digital or Analog. More...
 
virtual bool IsOutput ()=0
 Determine if an I/O point is an output. More...
 
Read/Write Digital I/O
virtual bool Get ()=0
 Get the state of Digital Input or Output. More...
 
virtual void Set (bool state)=0
 Set the state of a Digital Output. More...
 
Read/Write Analog I/O
virtual double ValueGet ()=0
 Get the value of an Analog Input or Output. More...
 
virtual void ValueSet (double value)=0
 Set the value for an Analog Output. 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 RsiErrorErrorLogGet ()=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...
 

Description

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

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

Examples
IOwithAKD.cpp, SingleAxisSyncOutputs.cpp, SingleAxisSyncOutputs.cs, SyncOutputWithMotion.cpp, UserLimitDigitalInputAction.cpp, UserLimitDigitalInputOneCondition.cpp, UserLimitDigitalInputOneCondition.cs, UserLimitDigitalInputTwoCondition.cpp, UserLimitPositionOneCondition.cpp, and UserLimitPositionOneCondition.cs.