LoadExistingMultiAxis()

MultiAxis * LoadExistingMultiAxis

(

int32_t

motionSupervisorNumber

)

Description:

Get/Create a MultiAxis object from one that already exists (previously setup) on the RMP motion controller firmware. This is the call RapidSetup uses to show previously created MultiAxis objects.

Parameters

motionSupervisorNumber

A motion supervisor index, should be >= AxisCount.

Returns

(MultiAxis*) A pointer to the MultiAxis specified.

Note

You'll need to set the number of MotionSupervisors to a number greater than the Axis count. This should be done before any calls to AxisGet or MultiAxisGet.

Creation Methods Info

Part of the Create and Initialize RapidCode Objects method group.

🔔 Important Usage Instructions

All creation methods, such as Create(), AxisGet(), NetworkNodeGet(), etc. Each return valid pointers to RapidCode objects. These pointers are never null, even when there is an error during object creation.

🔔 API Differences (C# vs. C++)

In the C# API, the pointers are replaced by references due to differences between C++ and C#. The creation methods return a reference to the object instead of a pointer. However, the method calls and error handling procedures remain the same. Null references are not returned by the creation methods in C#. Always check for errors after object creation, as described above.

⚙️ Error Checking After Creation

Immediately after the creation of a RapidCode object, you need to check if there were any errors during its creation. You do this by calling the ErrorLogCountGet() method on the created object. If ErrorLogCountGet() returns a value greater than zero, it means there were errors during the object creation.

⚙️ Handling Errors

To handle the errors, you call the ErrorLogGet() method once for each error on the created object to retrieve an RsiError object. You can then inspect the RsiError object to understand more about the error.

⚙️ Helper Functions

RapidCode also provides helper functions in both C++ and C#, like HelperFunctions::CheckErrors(), that work with all RapidCode objects. These helper functions operate on RapidCodeObject, hence they are compatible with all RapidCode objects. For example:

⚙️ Object Cleanup

Any and all objects created by RapidCode creation methods will be cleaned up by calling MotionController::Delete(). This should be done when your application is finished using RapidCode objects.

See also

ErrorLogCountGet, ErrorLogGet, Delete, HelperFunctions.CheckErrors

MultiAxis::AxisAdd , MotionCountGet , MotionCountSet