APIs, concepts, guides, and more
SampleAppsHelper

SampleAppsHelper namespace provides static methods for common tasks in RMP applications. More...

Functions

static void CheckErrors (RapidCodeObject *rsiObject)
 Checks for errors in the given RapidCodeObject and throws an exception if any non-warning errors are found.
static void Cleanup (MotionController *controller)
 Cleanup the controller and restore the object counts to the original values.
static void ClearControllerCounts (MotionController *controller)
 Clears count settings for axes, motion, and user limits on the controller.
static void ConfigurePhantomAxis (MotionController *controller, int axisNumber)
 Configures a specified axis as a phantom axis with custom settings.
static MotionController::CreationParameters GetCreationParameters ()
 Returns a MotionController::CreationParameters object with user-defined parameters.
static void PrintFooter (std::string sampleAppName, int exitCode)
 Print a message to indicate the sample app has finished and if it was successful or not.
static void PrintHeader (std::string sampleAppName)
 Print a start message to indicate that the sample app has started.
static void SetupController (MotionController *controller, int numAxes=0)
 Setup the controller with user defined axis counts and configuration.
static void SetupControllerForHardware (MotionController *controller)
 Sets up the controller for hardware use by resetting it and starting the network.
static void SetupControllerForPhantoms (MotionController *controller, int axisCount, std::vector< int > axisNums)
 Sets up the controller for phantom axes, including configuring specified axes as phantom.
static void ShutdownTheNetwork (MotionController *controller)
 Shuts down the network communication for the given MotionController.
static void StartTheNetwork (MotionController *controller)
 Starts the network communication for the given MotionController.

Variables

static int initialAxisCount = -1
 Initial axis count to restore later (-1 indicates it has not been set).
static int initialMotionCount = -1
 Initial motion count to restore later (-1 indicates it has not been set).

Description

This namespace encapsulates operations such as error checking, network management, and controller configuration to streamline application development.