Fix naming issues (#307)

We have been a bit inconsistent in the past when it comes to naming
public members.

While the changes in 71bab65 and
42cf147 would probably not impact many
people, the changes from bef94bb would
be more impactful.

Potentially there would be many more changes in the message structures
for the primary and RTDE interfaces which I have disabled for now.

Author: urfeex

.clang-tidy

@@ -3,6 +3,7 @@ CheckOptions:
   - { key: readability-identifier-naming.NamespaceCase,        value: lower_case }
   - { key: readability-identifier-naming.ClassCase,            value: CamelCase  }
   - { key: readability-identifier-naming.PrivateMemberSuffix,  value: _         }
+  - { key: readability-identifier-naming.PublicMemberSuffix,  value: ""         }
   - { key: readability-identifier-naming.StructCase,           value: CamelCase  }
   - { key: readability-identifier-naming.FunctionCase,         value: camelBack }
   - { key: readability-identifier-naming.VariableCase,         value: lower_case }

.github/workflows/industrial-ci.yml

@@ -35,5 +35,5 @@ jobs:
           DOWNSTREAM_WORKSPACE: ${{matrix.ROS_DISTRO.DOWNSTREAM_WORKSPACE}}
           ROS_DISTRO: ${{matrix.ROS_DISTRO.NAME}}
           ROS_REPO: ${{matrix.ROS_REPO}}
-          CLANG_TIDY: true
+          CLANG_TIDY: pedantic
           CLANG_TIDY_ARGS: '--extra-arg=-std=c++17'  # needed for Humble

doc/examples/instruction_executor.rst

@@ -21,7 +21,7 @@ The `instruction_executor.cpp <https://github.com/UniversalRobots/Universal_Robo
    :linenos:
    :lineno-match:
    :start-at: bool headless_mode = true;
-   :end-at: auto instruction_executor = std::make_shared<urcl::InstructionExecutor>(g_my_robot->ur_driver_);
+   :end-at: auto instruction_executor = std::make_shared<urcl::InstructionExecutor>(g_my_robot->getUrDriver());
 
 At first, a ``InstructionExecutor`` object is created with the URDriver object as it needs that
 for communication with the robot.
@@ -61,6 +61,6 @@ To run a single motion, the ``InstructionExecutor`` provides the methods ``moveJ
    :linenos:
    :lineno-match:
    :start-at: double goal_time_sec = 2.0;
-   :end-before: g_my_robot->ur_driver_->stopControl();
+   :end-before: g_my_robot->getUrDriver()->stopControl();
 
 Again, time parametrization has priority over acceleration / velocity parameters.

doc/examples/tool_contact_example.rst

@@ -20,7 +20,7 @@ At first, we create a initialize a driver as usual:
    :linenos:
    :lineno-match:
    :start-at: bool headless_mode = true;
-   :end-before: g_my_robot->ur_driver_->registerToolContactResultCallback
+   :end-before: g_my_robot->getUrDriver()->registerToolContactResultCallback
 
 We use a small helper function to make sure that the reverse interface is active and connected
 before proceeding.
@@ -45,8 +45,8 @@ This function is registered as a callback to the driver and then tool_contact mo
    :caption: examples/tool_contact_example.cpp
    :linenos:
    :lineno-match:
-   :start-at: g_my_robot->ur_driver_->registerToolContactResultCallback(&handleToolContactResult);
-   :end-at: g_my_robot->ur_driver_->startToolContact()
+   :start-at: g_my_robot->getUrDriver()->registerToolContactResultCallback(&handleToolContactResult);
+   :end-at: g_my_robot->getUrDriver()->startToolContact()
 
 Once everything is initialized, we can start a control loop commanding the robot to move in the
 negative z direction until the program timeout is hit or a tool contact is detected:

doc/examples/trajectory_point_interface.rst

@@ -45,8 +45,8 @@ That callback can be registered at the ``UrDriver`` object:
    :caption: examples/trajectory_point_interface.cpp
    :linenos:
    :lineno-match:
-   :start-at: g_my_robot->ur_driver_->registerTrajectoryDoneCallback(&trajDoneCallback);
-   :end-at: g_my_robot->ur_driver_->registerTrajectoryDoneCallback(&trajDoneCallback);
+   :start-at: g_my_robot->getUrDriver()->registerTrajectoryDoneCallback(&trajDoneCallback);
+   :end-at: g_my_robot->getUrDriver()->registerTrajectoryDoneCallback(&trajDoneCallback);
 
 
 MoveJ Trajectory
@@ -67,12 +67,12 @@ parameters. The following example shows execution of a 2-point trajectory using
 In fact, the path is followed twice, once parametrized by a segment duration and once using maximum
 velocity / acceleration settings. If a duration > 0 is given for a segment, the velocity and
 acceleration settings will be ignored as in the underlying URScript functions. In the example
-above, each of the ``g_my_robot->ur_driver_->writeTrajectoryPoint()`` calls will be translated into a
+above, each of the ``g_my_robot->getUrDriver()->writeTrajectoryPoint()`` calls will be translated into a
 ``movej`` command in URScript.
 
 While the trajectory is running, we need to tell the robot program that connection is still active
 and we expect the trajectory to be running. This is being done by the
-``g_my_robot->ur_driver_->writeTrajectoryControlMessage(urcl::control::TrajectoryControlMessage::TRAJECTORY_NOOP);``
+``g_my_robot->getUrDriver()->writeTrajectoryControlMessage(urcl::control::TrajectoryControlMessage::TRAJECTORY_NOOP);``
 call.
 
 MoveL Trajectory

doc/index.rst

@@ -15,3 +15,4 @@ can be found on `GitHub <https://github.com/UniversalRobots/Universal_Robots_Cli
    architecture
    examples
    real_time
+   migration_notes

doc/migration_notes.rst

@@ -0,0 +1,26 @@
+Migration notes
+===============
+
+This document contains notes on the migration of the ur_client_library between major versions.
+
+It contains only breaking changes.
+
+Migrating from 1.x.x to 2.x.x
+-----------------------------
+
+- In the ``urcl::ExampleRobotWrapper`` class the ``ur_driver_``, ``dashboard_client`` and
+  ``primary_client`` members are now private. Use ``getUrDriver()``, ``getDashboardClient()`` and
+  ``getPrimaryClient()`` to access them.
+
+- In ``urcl::comm::ControlModeTypes`` two member functions have been renamed:
+
+  - ``is_control_mode_realtime`` -> ``isControlModeRealtime``
+  - ``is_control_mode_non_realtime`` -> ``isControlModeNonRealtime``
+
+- In ``urcl::RobotReceiveTimeout`` the ``timeout_`` member is now private. Use
+  ``getAsMilliseconds()`` to access it.
+
+- In ``urcl::UrDriverConfiguration`` two members have been renamed:
+
+  - ``rtde_initialization_attempts_`` -> ``rtde_initialization_attempts``
+  - ``rtde_initialization_timeout_`` -> ``rtde_initialization_timeout``

examples/force_mode_example.cpp

@@ -57,7 +57,7 @@ std::unique_ptr<ExampleRobotWrapper> g_my_robot;
 
 void sendFreedriveMessageOrDie(const control::FreedriveControlMessage freedrive_action)
 {
-  bool ret = g_my_robot->ur_driver_->writeFreedriveControlMessage(freedrive_action);
+  bool ret = g_my_robot->getUrDriver()->writeFreedriveControlMessage(freedrive_action);
   if (!ret)
   {
     URCL_LOG_ERROR("Could not send joint command. Is the robot in remote control?");
@@ -91,7 +91,7 @@ int main(int argc, char* argv[])
     URCL_LOG_ERROR("Something in the robot initialization went wrong. Exiting. Please check the output above.");
     return 1;
   }
-  if (!g_my_robot->ur_driver_->checkCalibration(CALIBRATION_CHECKSUM))
+  if (!g_my_robot->getUrDriver()->checkCalibration(CALIBRATION_CHECKSUM))
   {
     URCL_LOG_ERROR("Calibration checksum does not match actual robot.");
     URCL_LOG_ERROR("Use the ur_calibration tool to extract the correct calibration from the robot and pass that into "
@@ -107,24 +107,24 @@ int main(int argc, char* argv[])
   // Task frame at the robot's base with limits being large enough to cover the whole workspace
   // Compliance in z axis and rotation around z axis
   bool success;
-  if (g_my_robot->ur_driver_->getVersion().major < 5)
-    success =
-        g_my_robot->ur_driver_->startForceMode({ 0, 0, 0, 0, 0, 0 },  // Task frame at the robot's base
-                                               { 0, 0, 1, 0, 0, 1 },  // Compliance in z axis and rotation around z axis
-                                               { 0, 0, -2, 0, 0, 0 },  // Press in -z direction
-                                               2,                      // do not transform the force frame at all
-                                               { 0.1, 0.1, 1.5, 3.14, 3.14, 0.5 },  // limits
-                                               0.005);  // damping_factor. See ScriptManual for details.
+  if (g_my_robot->getUrDriver()->getVersion().major < 5)
+    success = g_my_robot->getUrDriver()->startForceMode({ 0, 0, 0, 0, 0, 0 },   // Task frame at the robot's base
+                                                        { 0, 0, 1, 0, 0, 1 },   // Compliance in z axis and rotation
+                                                                                // around z axis
+                                                        { 0, 0, -2, 0, 0, 0 },  // Press in -z direction
+                                                        2,  // do not transform the force frame at all
+                                                        { 0.1, 0.1, 1.5, 3.14, 3.14, 0.5 },  // limits
+                                                        0.005);  // damping_factor. See ScriptManual for details.
   else
   {
-    success =
-        g_my_robot->ur_driver_->startForceMode({ 0, 0, 0, 0, 0, 0 },  // Task frame at the robot's base
-                                               { 0, 0, 1, 0, 0, 1 },  // Compliance in z axis and rotation around z axis
-                                               { 0, 0, -2, 0, 0, 0 },  // Press in -z direction
-                                               2,                      // do not transform the force frame at all
-                                               { 0.1, 0.1, 1.5, 3.14, 3.14, 0.5 },  // limits
-                                               0.005,                               // damping_factor
-                                               1.0);  // gain_scaling. See ScriptManual for details.
+    success = g_my_robot->getUrDriver()->startForceMode({ 0, 0, 0, 0, 0, 0 },   // Task frame at the robot's base
+                                                        { 0, 0, 1, 0, 0, 1 },   // Compliance in z axis and rotation
+                                                                                // around z axis
+                                                        { 0, 0, -2, 0, 0, 0 },  // Press in -z direction
+                                                        2,  // do not transform the force frame at all
+                                                        { 0.1, 0.1, 1.5, 3.14, 3.14, 0.5 },  // limits
+                                                        0.005,                               // damping_factor
+                                                        1.0);  // gain_scaling. See ScriptManual for details.
   }
   if (!success)
   {
@@ -138,13 +138,13 @@ int main(int argc, char* argv[])
   auto stopwatch_now = stopwatch_last;
   while (time_done < timeout || second_to_run.count() == 0)
   {
-    g_my_robot->ur_driver_->writeKeepalive();
+    g_my_robot->getUrDriver()->writeKeepalive();
 
     stopwatch_now = std::chrono::steady_clock::now();
     time_done += stopwatch_now - stopwatch_last;
     stopwatch_last = stopwatch_now;
     std::this_thread::sleep_for(std::chrono::milliseconds(2));
   }
   URCL_LOG_INFO("Timeout reached.");
-  g_my_robot->ur_driver_->endForceMode();
+  g_my_robot->getUrDriver()->endForceMode();
 }

examples/freedrive_example.cpp

@@ -55,7 +55,7 @@ std::unique_ptr<ExampleRobotWrapper> g_my_robot;
 
 void sendFreedriveMessageOrDie(const control::FreedriveControlMessage freedrive_action)
 {
-  bool ret = g_my_robot->ur_driver_->writeFreedriveControlMessage(freedrive_action);
+  bool ret = g_my_robot->getUrDriver()->writeFreedriveControlMessage(freedrive_action);
   if (!ret)
   {
     URCL_LOG_ERROR("Could not send joint command. Is there an external_control program running on the robot?");

examples/full_driver.cpp

@@ -71,7 +71,7 @@ int main(int argc, char* argv[])
 
   // Increment depends on robot version
   double increment_constant = 0.0005;
-  if (g_my_robot->ur_driver_->getVersion().major < 5)
+  if (g_my_robot->getUrDriver()->getVersion().major < 5)
   {
     increment_constant = 0.002;
   }
@@ -86,14 +86,14 @@ int main(int argc, char* argv[])
   // Once RTDE communication is started, we have to make sure to read from the interface buffer, as
   // otherwise we will get pipeline overflows. Therefor, do this directly before starting your main
   // loop.
-  g_my_robot->ur_driver_->startRTDECommunication();
+  g_my_robot->getUrDriver()->startRTDECommunication();
   while (!(passed_positive_part && passed_negative_part))
   {
     // Read latest RTDE package. This will block for a hard-coded timeout (see UrDriver), so the
     // robot will effectively be in charge of setting the frequency of this loop.
     // In a real-world application this thread should be scheduled with real-time priority in order
     // to ensure that this is called in time.
-    std::unique_ptr<rtde_interface::DataPackage> data_pkg = g_my_robot->ur_driver_->getDataPackage();
+    std::unique_ptr<rtde_interface::DataPackage> data_pkg = g_my_robot->getUrDriver()->getDataPackage();
     if (!data_pkg)
     {
       URCL_LOG_WARN("Could not get fresh data package from robot");
@@ -133,16 +133,16 @@ int main(int argc, char* argv[])
     joint_target[5] += increment;
     // Setting the RobotReceiveTimeout time is for example purposes only. This will make the example running more
     // reliable on non-realtime systems. Use with caution in productive applications.
-    bool ret = g_my_robot->ur_driver_->writeJointCommand(joint_target, comm::ControlMode::MODE_SERVOJ,
-                                                         RobotReceiveTimeout::millisec(100));
+    bool ret = g_my_robot->getUrDriver()->writeJointCommand(joint_target, comm::ControlMode::MODE_SERVOJ,
+                                                            RobotReceiveTimeout::millisec(100));
     if (!ret)
     {
       URCL_LOG_ERROR("Could not send joint command. Is the robot in remote control?");
       return 1;
     }
     URCL_LOG_DEBUG("data_pkg:\n%s", data_pkg->toString().c_str());
   }
-  g_my_robot->ur_driver_->stopControl();
+  g_my_robot->getUrDriver()->stopControl();
   URCL_LOG_INFO("Movement done");
   return 0;
 }