MoveIt 2

https://moveit.picknik.ai/humble/
Admin
MoveIt 2 is the robotic manipulation platform for ROS 2 that provides motion planning, 3D...
Tokens:4,431,752
Snippets:35,839
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Get Setup Step Name

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1simulation_1_1Simulation.html

Returns the name of the setup step.

```cpp
std::string moveit_setup::simulation::Simulation::getName() const override
```

--------------------------------

### Install Docker

Source: https://moveit.picknik.ai/humble/doc/examples/ikfast/ikfast_tutorial.html

Install Docker and start the Docker service. Ensure your user has permission to run Docker commands by adding it to the 'docker' group.

```bash
sudo apt-get install docker.io
sudo service docker start

```

```bash
sudo usermod -a -G docker $USER

```

--------------------------------

### Setup Start Client for Servo

Source: https://moveit.picknik.ai/humble/api/html/servo__launch__test__common_8hpp_source.html

Creates a client for the 'start_servo' service and waits until the service is ready.

```cpp
bool setupStartClient()
{
  // Start client
  client_servo_start_ = node_->create_client<std_srvs::srv::Trigger>(resolveServoTopicName("~/start_servo"));
  while (!client_servo_start_->service_is_ready())
  {
    if (!rclcpp::ok())
    {

```

--------------------------------

### Get Instructions

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1controllers_1_1Controllers.html

Retrieves instructions or guidance text for the current setup step. This is an abstract method.

```APIDOC
## getInstructions()

### Description
Provides instructions or guidance text for the user regarding this setup step.

### Method Signature
`virtual std::string getInstructions() const = 0`

### Returns
- `std::string`: The instruction text.
```

--------------------------------

### Get Name

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1controllers_1_1Controllers.html

Returns the name of the setup step. This is an abstract method.

```APIDOC
## getName()

### Description
Returns the unique name identifier for this setup step.

### Method Signature
`virtual std::string getName() const = 0`

### Returns
- `std::string`: The name of the setup step.
```

--------------------------------

### Run hello_moveit Program

Source: https://moveit.picknik.ai/humble/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.html

Navigate to your workspace, source the setup file, and run the hello_moveit executable to start the visualization.

```bash
cd ~/ws_moveit2
source install/setup.bash
ros2 run hello_moveit hello_moveit

```

--------------------------------

### Pose Tracking Example Launch File

Source: https://moveit.picknik.ai/humble/api/html/dir_48560f4f08bb59f30291ddef489b7574.html

This launch file is used to start the pose tracking example in MoveIt. It requires the `moveit_ros` package.

```python
from moveit_configs_utils import MoveItConfigsBuilder

def generate_launch_description():
    moveit_config = MoveItConfigsBuilder("name", package_name="moveit_resources_panda").to_moveit_configs()
    return {moveit_config.to_launch_configuration()}

```

--------------------------------

### Launch Planning Scene Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/planning_scene/planning_scene_tutorial.html

Launches the planning scene tutorial node using ros2 launch. This command starts the example execution.

```bash
ros2 launch moveit2_tutorials planning_scene_tutorial.launch.py
```

--------------------------------

### Launch RViz Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/visualizing_collisions/visualizing_collisions_tutorial.html

Launches the interactive tutorial for visualizing collisions in RViz. Ensure you have completed the Getting Started steps.

```bash
roslaunch moveit_tutorials visualizing_collisions_tutorial.launch

```

--------------------------------

### Setup Servo Start Client

Source: https://moveit.picknik.ai/humble/api/html/servo__launch__test__common_8hpp_source.html

Initializes the client for the 'start_servo' service. It waits until the service is ready or the ROS 2 node is shut down.

```cpp
bool setupStartClient()
{
  client_servo_start_ = node_->create_client<std_srvs::srv::Trigger>(resolveServoTopicName("~/start_servo"));
  while (!client_servo_start_->service_is_ready())
  {
    if (!rclcpp::ok())
    {
      RCLCPP_ERROR(LOGGER, "Interrupted while waiting for the service. Exiting.");
      return false;
    }
    RCLCPP_INFO(LOGGER, "client_servo_start_ service not available, waiting again...");
    rclcpp::sleep_for(std::chrono::milliseconds(500));
  }
  return true;
}
```

--------------------------------

### Launch Hybrid Planning Demo

Source: https://moveit.picknik.ai/humble/doc/examples/hybrid_planning/hybrid_planning_tutorial.html

Run this command to start the hybrid planning demo. Ensure you have completed the initial setup steps.

```bash
ros2 launch moveit_hybrid_planning hybrid_planning_demo.launch.py

```

--------------------------------

### setupStartClient

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__servo_1_1ServoFixture.html

Sets up a client for the start service.

```APIDOC
## setupStartClient()

### Description
Initializes and sets up a client for the start service. Returns true if successful, false otherwise.

### Signature
`bool moveit_servo::ServoFixture::setupStartClient()`
```

--------------------------------

### Initialize Robot State and Planning Scene

Source: https://moveit.picknik.ai/humble/doc/examples/creating_moveit_plugins/plugin_tutorial.html

Get the robot state, joint model group, and planning scene for motion planning. This is the initial setup required before defining start and goal states.

```cpp
moveit::core::RobotStatePtr robot_state(new moveit::core::RobotState(robot_model));
const moveit::core::JointModelGroup* joint_model_group = robot_state->getJointModelGroup(PLANNING_GROUP);
const std::vector<std::string>& joint_names = joint_model_group->getVariableNames();
planning_scene::PlanningScenePtr planning_scene(new planning_scene::PlanningScene(robot_model));

```

--------------------------------

### Start Move Group Interface Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/move_group_interface/move_group_interface_tutorial.html

Run the tutorial launch file to start the Move Group Interface demo.

```bash
ros2 launch moveit2_tutorials move_group_interface_tutorial.launch.py

```

--------------------------------

### Get Start State

Source: https://moveit.picknik.ai/humble/api/html/classmoveit_1_1planning__interface_1_1MoveGroupInterface_1_1MoveGroupInterfaceImpl.html

Retrieves the start state of the robot.

```APIDOC
## getStartState

### Description
Retrieves the start state of the robot.

### Method
`moveit::core::RobotStatePtr getStartState()`
```

--------------------------------

### setupStartClient

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__servo_1_1ServoFixture.html

Sets up the client for starting the servo.

```APIDOC
## setupStartClient

### Description
Initializes and sets up the ROS client for the 'start servo' service.

### Method
bool setupStartClient()

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
* **bool** - True if the client was set up successfully, false otherwise.

### Response Example
None
```

--------------------------------

### setupStartClient

Source: https://moveit.picknik.ai/humble/api/html/functions_func_s.html

Sets up the start client for ServoFixture.

```APIDOC
## setupStartClient()

### Description
Configures and initializes the client for start commands within the `ServoFixture`.

### Method
Not specified (likely a C++ method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Response
Returns void or modifies the state of `moveit_servo::ServoFixture`.
```

--------------------------------

### BaseCmd Get Start Configuration (Non-const)

Source: https://moveit.picknik.ai/humble/api/html/basecmd_8h_source.html

Returns a reference to the start configuration. This allows modification of the start configuration.

```cpp
template <class StartType, class GoalType>
inline StartType& BaseCmd<StartType, GoalType>::getStartConfiguration()
{
return start_;
}
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classPerceptionTest.html

Initializes the node, DataWarehouse, and output directory. This is an override of the base class SetUp method.

```APIDOC
## SetUp()

### Description
Initializes the node, DataWarehouse, and output directory.

### Method
void

### Parameters
None

### Response
None
```

--------------------------------

### BaseCmd Get Start Configuration (Const)

Source: https://moveit.picknik.ai/humble/api/html/basecmd_8h_source.html

Returns a constant reference to the start configuration. This prevents modification of the start configuration.

```cpp
template <class StartType, class GoalType>
inline const StartType& BaseCmd<StartType, GoalType>::getStartConfiguration() const
{
return start_;
}
```

--------------------------------

### Launch MoveIt Robot Model and Robot State Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/robot_model_and_robot_state/robot_model_and_robot_state_tutorial.html

Launches the MoveIt robot model and robot state tutorial. Ensure you have completed the 'Getting Started' steps.

```bash
ros2 launch moveit2_tutorials robot_model_and_robot_state_tutorial.launch.py

```

--------------------------------

### moveit_setup::core::StartScreen

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1core_1_1StartScreen-members.html

Provides methods to get package and URDF paths, and inherits from moveit_setup::SetupStep.

```APIDOC
## Class moveit_setup::core::StartScreen

### Description
This class represents the start screen in the MoveIt Setup Assistant, providing functionality to retrieve configuration details.

### Methods
#### `getPackagePath()`
- **Description**: Retrieves the path to the MoveIt package.
- **Signature**: `getPackagePath()`

#### `getURDFPath()`
- **Description**: Retrieves the path to the URDF file.
- **Signature**: `getURDFPath()`

#### `getName() const override`
- **Description**: Returns the name of the setup step.
- **Signature**: `getName() const override`
- **Inherited from**: `moveit_setup::SetupStep`

#### `getLogger() const`
- **Description**: Retrieves the logger for this setup step.
- **Signature**: `getLogger() const`
- **Inherited from**: `moveit_setup::SetupStep`

### Protected Members
#### `config_data_`
- **Description**: Stores configuration data for the setup step.
- **Type**: `moveit_setup::SetupStep`
```

--------------------------------

### Get Start Pose Name

Source: https://moveit.picknik.ai/humble/api/html/classpilz__industrial__motion__planner__testutils_1_1CmdReader.html

Retrieves the start pose name from the command data.

```APIDOC
## getStartPoseName()

### Description
Returns the name of the start pose specified in the command.

### Returns
* std::string - The name of the start pose.
```

--------------------------------

### initialize

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1SetupStepWidget-members.html

Initializes the SetupStepWidget with necessary components.

```APIDOC
## initialize

### Description
Initializes the SetupStepWidget with necessary components, including the parent node, parent widget, RViz panel, and configuration data.

### Method
`initialize(const rclcpp::Node::SharedPtr &parent_node, QWidget *parent_widget, RVizPanel *rviz_panel, const DataWarehousePtr &config_data)`

### Parameters
- **parent_node** (rclcpp::Node::SharedPtr) - The ROS 2 node to use.
- **parent_widget** (QWidget *) - The parent widget for this widget.
- **rviz_panel** (RVizPanel *) - The RViz panel associated with this widget.
- **config_data** (DataWarehousePtr) - The data warehouse for configuration.
```

--------------------------------

### Get Start Index

Source: https://moveit.picknik.ai/humble/api/html/chomp__trajectory_8h_source.html

Returns the starting index of the segment of the trajectory that is considered for optimization.

```cpp
inline size_t ChompTrajectory::getStartIndex() const
{
  return start_index_;
}
```

--------------------------------

### ChompTrajectory Get Start Index

Source: https://moveit.picknik.ai/humble/api/html/chomp__trajectory_8h_source.html

Returns the start index (inclusive) of the trajectory segment to be optimized.

```cpp
size_t getStartIndex() const;
```

--------------------------------

### getStartState()

Source: https://moveit.picknik.ai/humble/api/html/classmoveit_1_1planning__interface_1_1MoveGroupInterface_1_1MoveGroupInterfaceImpl-members.html

Gets the start state for planning.

```APIDOC
## getStartState()

### Description
Gets the start state that is currently configured for motion planning.

### Method
`moveit::core::RobotStatePtr`

### Endpoint
N/A (Method Call)
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classpilz__extensions__tests_1_1JointLimitTest-members.html

This is an overridden protected method for setting up the test environment.

```APIDOC
## SetUp()

### Description
Protected method to set up the test environment. It is an override of a base class method.

### Method
protected

### Signature
`SetUp() override`
```

--------------------------------

### getStartIndex

Source: https://moveit.picknik.ai/humble/api/html/classchomp_1_1ChompTrajectory.html

Gets the start index of the trajectory.

```APIDOC
## getStartIndex()

### Description
Gets the start index.

### Method
`size_t getStartIndex() const`

### Definition
`chomp_trajectory.h` line 261
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classTestConstrainedStateSpace.html

Sets up the testing environment before each test case.

```APIDOC
## SetUp()

### Description
Performs setup operations before a test.

### Method
`void SetUp() override`
```

--------------------------------

### Get State at Duration from Start

Source: https://moveit.picknik.ai/humble/api/html/robot__trajectory_8h_source.html

Retrieves the robot state at a specific duration from the start of the trajectory. Useful for interpolating states.

```cpp
bool getStateAtDurationFromStart(const double request_duration, moveit::core::RobotStatePtr& output_state) const;
```

--------------------------------

### getWayPointDurationFromStart

Source: https://moveit.picknik.ai/humble/api/html/functions_func_g.html

Gets the duration from the start of the trajectory to a specific waypoint.

```APIDOC
## getWayPointDurationFromStart

### Description
Gets the duration from the start of the trajectory to a specific waypoint.

### Signature
`getWayPointDurationFromStart(index: int) : robot_trajectory::RobotTrajectory`
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classTiming.html

Initializes the timing setup. This is an inline, override, and protected member function.

```APIDOC
## SetUp()

### Description
Initializes the timing setup.

### Signature
`void Timing::SetUp()`

### Details
- inline
- override
- protected

### Defined in
`robot_state_benchmark.cpp`, line 75
```

--------------------------------

### Launch MoveItCpp Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/moveit_cpp/moveitcpp_tutorial.html

Run the MoveItCpp tutorial launch file to start the RViz visualization and interactive demo.

```bash
ros2 launch moveit2_tutorials moveit_cpp_tutorial.launch.py

```

--------------------------------

### Initialize Setup Step

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1simulation_1_1Simulation.html

Initializes the setup step with a parent node and configuration data.

```cpp
void moveit_setup::simulation::Simulation::initialize(const rclcpp::Node::SharedPtr &parent_node, const DataWarehousePtr &config_data)
```

--------------------------------

### Source Workspace Setup File

Source: https://moveit.picknik.ai/humble/doc/examples/stomp_planner/stomp_planner_tutorial.html

After building the workspace, re-source the setup file to make the installed packages available in your current shell session.

```bash
source ~/ws_moveit/devel/setup.bash
```

--------------------------------

### setup

Source: https://moveit.picknik.ai/humble/api/html/functions_func_s.html

Sets up a helper for byte string testing.

```APIDOC
## setup()

### Description
Configures and initializes a helper for testing byte string serialization and deserialization.

### Method
Not specified (likely a C++ method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Response
Returns an object of type `ByteStringTestHelper`.
```

--------------------------------

### Get State at Duration From Start

Source: https://moveit.picknik.ai/humble/api/html/robot__trajectory_8cpp_source.html

Attempts to retrieve the robot state at a specific duration from the start of the trajectory. Returns false if the trajectory is empty.

```cpp
bool RobotTrajectory::getStateAtDurationFromStart(const double request_duration,
                                                  moveit::core::RobotStatePtr& output_state) const
{
    // If there are no waypoints we can't do anything
    if (getWayPointCount() == 0)
        return false;

    int before = 0, after = 0;

```

--------------------------------

### onInit()

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1SetupStep-members.html

Initializes the setup step. This is a virtual function that should be implemented by derived classes to perform any necessary setup logic.

```APIDOC
## onInit()

### Description
Initializes the setup step. This is a virtual function that should be implemented by derived classes to perform any necessary setup logic.

### Method
`virtual void onInit()`

### Parameters
None

### Returns
None
```

--------------------------------

### Initialize

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1controllers_1_1Controllers.html

Initializes the setup step with the parent node and configuration data.

```APIDOC
## initialize()

### Description
Called after the object's construction to perform initial setup using the provided ROS 2 node and data warehouse.

### Method Signature
`void initialize(const rclcpp::Node::SharedPtr &parent_node, const DataWarehousePtr &config_data)`

### Parameters
- `parent_node` (const rclcpp::Node::SharedPtr &): A shared pointer to the parent ROS 2 node.
- `config_data` (const DataWarehousePtr &): A pointer to the data warehouse for configuration.
```

--------------------------------

### Launch MoveIt Setup Assistant

Source: https://moveit.picknik.ai/humble/doc/examples/setup_assistant/setup_assistant_tutorial.html

Starts the MoveIt Setup Assistant GUI. This command launches the tool for creating or editing MoveIt configuration packages.

```bash
roslaunch moveit_setup_assistant setup_assistant.launch

```

--------------------------------

### Get Current or Considered Start State

Source: https://moveit.picknik.ai/humble/api/html/planning__component_8cpp_source.html

Retrieves the current start state. If a specific start state has been set using `setStartState`, it returns that. Otherwise, it fetches the robot's current state from the `moveit_cpp_` interface.

```cpp
moveit::core::RobotStatePtr PlanningComponent::getStartState()
{
 if (considered_start_state_)
 return considered_start_state_;
 else
 {
 moveit::core::RobotStatePtr s;
 moveit_cpp_->getCurrentState(s, 1.0);
 return s;
 }
}
```

--------------------------------

### Get Logger

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1simulation_1_1Simulation.html

Provides access to a namespaced logger for this setup step.

```cpp
const rclcpp::Logger & moveit_setup::simulation::Simulation::getLogger() const
```

--------------------------------

### Get Logger

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1controllers_1_1Controllers.html

Provides access to a namespaced logger for this setup step.

```APIDOC
## getLogger()

### Description
Returns a logger instance specific to this setup step, allowing for categorized logging.

### Method Signature
`const rclcpp::Logger& getLogger() const`

### Returns
- `const rclcpp::Logger&`: A constant reference to the logger object.
```

--------------------------------

### setupStartClient

Source: https://moveit.picknik.ai/humble/api/html/servo__launch__test__common_8hpp_source.html

Sets up the ROS 2 client for the 'start_servo' service.

```APIDOC
## setupStartClient()

### Description
Creates a ROS 2 client for the `~/start_servo` service. It waits until the service is ready to accept calls, logging information messages during the wait and error messages if the ROS 2 node is interrupted.

### Method
`bool setupStartClient()`

### Returns
`true` if the client is successfully set up and the service is ready, `false` if the ROS 2 node is shut down during the wait.

### Notes
This function is part of the broader servo setup process and ensures the 'start' service is available before proceeding.
```

--------------------------------

### initializeStep()

Source: https://moveit.picknik.ai/humble/api/html/classPerceptionTest.html

Initializes a given setup step.

```APIDOC
## initializeStep(SetupStep &setup_step)

### Description
Initializes a given setup step.

### Method
void

### Parameters
- **setup_step** (SetupStep &) - The setup step to initialize.

### Response
None
```

--------------------------------

### ChompTrajectory::getStartIndex

Source: https://moveit.picknik.ai/humble/api/html/chomp__trajectory_8h_source.html

Gets the start index of the optimizable portion of the trajectory.

```APIDOC
## ChompTrajectory::getStartIndex

### Description
Gets the start index of the optimizable portion of the trajectory.

### Signature
`inline size_t ChompTrajectory::getStartIndex() const`

### Returns
`size_t` - The start index.
```

--------------------------------

### Run TrajOpt Example Launch File

Source: https://moveit.picknik.ai/humble/doc/examples/trajopt_planner/trajopt_planner_tutorial.html

After launching the demo, run the TrajOpt example launch file from the moveit_tutorials repository.

```bash
roslaunch moveit_tutorials trajopt_example_launch.launch
```

--------------------------------

### onInit

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1srdf__setup_1_1DefaultCollisions.html

Overridable initialization method for the setup step.

```APIDOC
## onInit

### Description
Overridable initialization method for the setup step.

### Signature
void onInit() override

### Remarks
This method is called after the step is constructed and can be overridden to perform custom initialization logic.
```

--------------------------------

### Generate MoveIt Setup Assistant Launch

Source: https://moveit.picknik.ai/humble/api/html/launches_8py_source.html

Creates a launch file to start the MoveIt Setup Assistant. This tool helps in configuring MoveIt parameters for a robot.

```python
def generate_setup_assistant_launch(moveit_config):
    """Launch file for MoveIt Setup Assistant"""
    ld = LaunchDescription()

    ld.add_action(DeclareBooleanLaunchArg("debug", default_value=False))
    add_debuggable_node(
        ld,
        package="moveit_setup_assistant",
        executable="moveit_setup_assistant",
        arguments=[["--config_pkg=", str(moveit_config.package_path)]],
    )

    return ld
```

--------------------------------

### Launch Planning Scene ROS API Tutorial

Source: https://moveit.picknik.ai/humble/doc/examples/planning_scene_ros_api/planning_scene_ros_api_tutorial.html

Launches the tutorial node. Run this in the second shell.

```bash
ros2 launch moveit2_tutorials planning_scene_ros_api_tutorial.launch.py

```

--------------------------------

### getQueryStartStateHandler

Source: https://moveit.picknik.ai/humble/api/html/functions_func_g.html

Gets the handler for the query start state from the motion planning display.

```APIDOC
## getQueryStartStateHandler()

### Description
Gets the handler for the query start state from the motion planning display.

### Returns
- `moveit_rviz_plugin::MotionPlanningDisplay`
```

--------------------------------

### ConfigurationFiles::onInit

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1core_1_1ConfigurationFiles.html

An overridable method for performing initialization tasks when the setup step is started.

```APIDOC
## onInit

### Description
Overridable initialization method. This method is called when the setup step is initialized.

### Signature
void onInit() override
```

--------------------------------

### initialize

Source: https://moveit.picknik.ai/humble/api/html/classoccupancy__map__monitor_1_1DepthImageOctomapUpdater.html

Performs necessary setup, such as subscribing to ROS topics. Assumes setMonitor() and setParams() have been called.

```APIDOC
## initialize(const rclcpp::Node::SharedPtr &node)

### Description
Do any necessary setup (subscribe to ros topics, etc.). This call assumes setMonitor() and setParams() have been previously called.

### Method
`bool initialize(const rclcpp::Node::SharedPtr &node)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **bool**: True if initialization was successful, false otherwise.

#### Response Example
None
```

--------------------------------

### testutils::getWayPointIndex

Source: https://moveit.picknik.ai/humble/api/html/test__utils_8h.html

Gets the waypoint index from a robot trajectory based on the time from the start.

```APIDOC
## testutils::getWayPointIndex

### Description
Gets the waypoint index from a robot trajectory based on the time from the start.

### Signature
int | testutils::getWayPointIndex (const robot_trajectory::RobotTrajectoryPtr &trajectory, const double time_from_start)
```

--------------------------------

### initialize

Source: https://moveit.picknik.ai/humble/api/html/classoccupancy__map__monitor_1_1OccupancyMapUpdater.html

Performs necessary setup, such as subscribing to ROS topics. Assumes setMonitor() and setParams() have been called.

```APIDOC
## virtual bool initialize(const rclcpp::Node::SharedPtr &node)=0

### Description
Initializes the updater by performing necessary setup tasks, such as subscribing to ROS topics. This function requires that `setMonitor()` and `setParams()` have been previously called.

### Parameters
- **node** (const rclcpp::Node::SharedPtr &) - A shared pointer to the ROS node used for setup.

### Returns
- `true` if initialization was successful, `false` otherwise.
```

--------------------------------

### initialize

Source: https://moveit.picknik.ai/humble/api/html/classoccupancy__map__monitor_1_1PointCloudOctomapUpdater.html

Performs necessary setup, such as subscribing to ROS topics. Assumes setMonitor() and setParams() have been called.

```APIDOC
## initialize(const rclcpp::Node::SharedPtr &node)

### Description
Do any necessary setup (subscribe to ros topics, etc.). This call assumes setMonitor() and setParams() have been previously called.

### Method
`bool initialize(const rclcpp::Node::SharedPtr &node)`

### Endpoint
N/A

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
N/A

### Response
#### Success Response (bool)
Returns true if initialization was successful, false otherwise.

#### Response Example
N/A
```

--------------------------------

### Getting State at Duration

Source: https://moveit.picknik.ai/humble/api/html/robot__trajectory_8h_source.html

Retrieves the robot state at a specific duration from the start of the trajectory.

```APIDOC
## getStateAtDurationFromStart

### Description
Interpolates and returns the robot state at a specific duration from the start of the trajectory.

### Method
`bool getStateAtDurationFromStart(const double request_duration, moveit::core::RobotStatePtr& output_state) const`

### Parameters
- **request_duration** (const double&) - The desired duration from the start of the trajectory.
- **output_state** (moveit::core::RobotStatePtr&) - Output parameter to store the interpolated robot state.
```

--------------------------------

### MoveItControllers::getButtonText

Source: https://moveit.picknik.ai/humble/api/html/moveit__controllers_8hpp_source.html

Gets the text to be displayed on a button associated with this controller setup step.

```APIDOC
## getButtonText

### Description
Gets the text for the button associated with this setup step.

### Method
`std::string getButtonText() const override`
```

--------------------------------

### BenchmarkOptions::getStartStateRegex

Source: https://moveit.picknik.ai/humble/api/html/BenchmarkExecutor_8cpp_source.html

Gets the regular expression used for matching start state names.

```APIDOC
## getStartStateRegex

### Description
Gets the regular expression used for matching start state names.

### Method
`const std::string & getStartStateRegex() const`
```

--------------------------------

### Initialize Demo Database C++ Source File

Source: https://moveit.picknik.ai/humble/api/html/dir_7981bd8b0a0dcd37b0cbc427474be2bb.html

Source code for initializing the demonstration database.

```cpp
// Source file: initialize_demo_db.cpp
//
// Created by picknik on 10/26/23.
//

```

--------------------------------

### BenchmarkOptions::getStartStateRegex

Source: https://moveit.picknik.ai/humble/api/html/BenchmarkOptions_8h_source.html

Get the regex expression for matching the names of all start states to plan from.

```APIDOC
## BenchmarkOptions::getStartStateRegex

### Description
Get the regex expression for matching the names of all start states to plan from.

### Method
Getter

### Return Value
const std::string & - The regex expression for start states.
```

--------------------------------

### Source Setup Files

Source: https://moveit.picknik.ai/humble/doc/examples/planning_adapters/planning_adapters_tutorial.html

After installing MoveIt from source or making changes to your workspace, re-source the setup files to update your environment variables. This is crucial for the system to recognize the newly built packages.

```bash
source ~/ws_moveit/devel/setup.bash

```

--------------------------------

### Run Motion Planning API Tutorial Launch File

Source: https://moveit.picknik.ai/humble/doc/examples/motion_planning_api/motion_planning_api_tutorial.html

Execute the tutorial's launch file in a separate shell to begin the motion planning demonstration.

```bash
ros2 launch moveit2_tutorials motion_planning_api_tutorial.launch.py

```

--------------------------------

### moveit_servo::ServoFixture::setupStartClient

Source: https://moveit.picknik.ai/humble/api/html/servo__launch__test__common_8hpp_source.html

Sets up a ROS client for the start service.

```APIDOC
## setupStartClient

### Description
Initializes a ROS client to interact with a service that starts servo operations.

### Method
bool

### Parameters
None

### Returns
`true` if the client was set up successfully, `false` otherwise.
```

--------------------------------

### Setup CAN Interface

Source: https://moveit.picknik.ai/humble/api/html/md_moveit_planners_pilz_industrial_motion_planner_test_acceptance_tests_acceptance_test_ptp.html

Use this command to bring up the CAN interface with a specified bitrate. Ensure the interface name and bitrate are correct for your setup.

```bash
sudo ip link set can0 up type can bitrate 1000000
```

--------------------------------

### Get Waypoint Duration From Start (Alias)

Source: https://moveit.picknik.ai/humble/api/html/robot__trajectory_8cpp_source.html

An alias for getWayPointDurationFromStart, providing an alternative name for the same functionality.

```cpp
double RobotTrajectory::getWaypointDurationFromStart(std::size_t index) const
{
    return getWayPointDurationFromStart(index);
}
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classDistanceFieldCollisionDetectionTester.html

The SetUp() method is called before each test case to initialize the testing environment.

```APIDOC
## SetUp()

### Description
Initializes the testing environment before each test.

### Signature
`void DistanceFieldCollisionDetectionTester::SetUp()`

### Definition
`test_collision_distance_field.cpp`, line 58
```

--------------------------------

### ConfigurationFiles::initialize

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1core_1_1ConfigurationFiles.html

Initializes the setup step with a ROS node and data warehouse.

```APIDOC
## initialize

### Description
Called after construction to initialize the setup step. It requires a ROS node and a data warehouse for configuration data.

### Signature
void initialize(const rclcpp::Node::SharedPtr& parent_node, const DataWarehousePtr& config_data)

### Parameters
* **parent_node** (const rclcpp::Node::SharedPtr&): A shared pointer to the parent ROS 2 node.
* **config_data** (const DataWarehousePtr&): A shared pointer to the data warehouse containing configuration data.
```

--------------------------------

### Get Current Start State

Source: https://moveit.picknik.ai/humble/api/html/move__group__interface_8cpp_source.html

Retrieves the current start state of the robot. This function converts the internal representation to a MoveIt! RobotState pointer, ensuring it's ready for use in motion planning.

```cpp
moveit::core::RobotStatePtr getStartState()
{
moveit::core::RobotStatePtr s;
getCurrentState(s);
moveit::core::robotStateMsgToRobotState(considered_start_state_, *s, true);
return s;
}
```

--------------------------------

### Get Waypoint Duration From Start

Source: https://moveit.picknik.ai/humble/api/html/robot__trajectory_8cpp_source.html

Calculates the cumulative duration from the start of the trajectory to a specified waypoint index. If the index is out of bounds, it uses the last waypoint's duration. Returns 0.0 if the trajectory has no waypoints.

```cpp
double RobotTrajectory::getWayPointDurationFromStart(std::size_t index) const
{
    if (duration_from_previous_.empty())
        return 0.0;
    if (index >= duration_from_previous_.size())
        index = duration_from_previous_.size() - 1;

    double time = 0.0;
    for (std::size_t i = 0; i <= index; ++i)
        time += duration_from_previous_[i];
    return time;
}
```

--------------------------------

### isReady

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1srdf__setup_1_1DefaultCollisions.html

Checks if the setup step is ready to proceed.

```APIDOC
## isReady

### Description
Return true if the data necessary to proceed with this step has been configured.

### Signature
bool isReady() const override

### Returns
True if the step is ready, false otherwise.
```

--------------------------------

### Test Motion Plan Generation with Colinear Start, Interim, and Goal

Source: https://moveit.picknik.ai/humble/api/html/unittest__trajectory__generator__circ_8cpp_source.html

Tests motion plan generation when the start, auxiliary, and goal configurations are colinear. This setup involves specific offsets to create the colinear condition.

```cpp
TEST_F(TrajectoryGeneratorCIRCTest, colinearCenterAndInterim)
{
    auto circ{ tdp_->getCircCartInterimCart("circ3_interim") };

    // alter start, interim and goal such that start/center and interim are
    // colinear
    circ.getAuxiliaryConfiguration().getConfiguration().setPose(circ.getStartConfiguration().getPose());
    circ.getGoalConfiguration().setPose(circ.getStartConfiguration().getPose());

    circ.getStartConfiguration().getPose().position.x -= 0.2;
    circ.getAuxiliaryConfiguration().getConfiguration().getPose().position.x += 0.2;
    circ.getGoalConfiguration().getPose().position.y -= 0.2;

}
```

--------------------------------

### Initialization and Setup

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__ros__benchmarks_1_1BenchmarkExecutor-members.html

Methods for initializing the BenchmarkExecutor and setting up the benchmarking environment.

```APIDOC
## BenchmarkExecutor Constructor

### Description
Constructs a BenchmarkExecutor object.

### Method
`BenchmarkExecutor(const rclcpp::Node::SharedPtr &node, const std::string &robot_description_param="robot_description")`

### Parameters
- **node** (const rclcpp::Node::SharedPtr &) - A shared pointer to the ROS 2 node.
- **robot_description_param** (const std::string &) - The name of the robot description parameter. Defaults to "robot_description".

## initialize

### Description
Initializes the benchmark executor with a list of planner plugin classes.

### Method
`initialize(const std::vector<std::string> &plugin_classes)`

### Parameters
- **plugin_classes** (const std::vector<std::string> &) - A vector of strings, where each string is the name of a planner plugin class to be used.

## clear

### Description
Clears all benchmark data and resets the executor to its initial state.

### Method
`clear()`
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1MoveItSetupTest.html

Initializes the ROS node, DataWarehouse, and output directory for the test environment. This method can be overridden to register custom data types after the base setup.

```APIDOC
## SetUp()

### Description
Initialize the node, DataWarehouse and output dir. You may want to override this method to register data types after calling MoveItSetupTest::SetUp().

### Method
void

### Parameters
None

### Definition
* File: testing_utils.hpp
* Line: 58
```

--------------------------------

### SelectModeWidget Constructor

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1core_1_1SelectModeWidget.html

Constructs a SelectModeWidget object. This widget is typically used on the start screen of the MoveIt Setup Assistant.

```APIDOC
## `SelectModeWidget()`

### Description
Constructor for the `SelectModeWidget` class.

### Signature
`moveit_setup::core::SelectModeWidget::SelectModeWidget(QWidget * _parent_)`

### Parameters
*   `_parent_` (QWidget *) - The parent widget for this widget.
```

--------------------------------

### SetUp

Source: https://moveit.picknik.ai/humble/api/html/classPandaConstraintTest.html

Sets up the test environment. This method is overridden from the base class.

```APIDOC
## SetUp()

### Description
Sets up the test environment. This method is overridden from the base class.

### Method
void SetUp()

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### Check Setup Step Readiness

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1simulation_1_1Simulation.html

Returns true if the necessary data for this step has been configured.

```cpp
bool moveit_setup::simulation::Simulation::isReady() const override
```

--------------------------------

### BaseCmd Member Functions

Source: https://moveit.picknik.ai/humble/api/html/classpilz__industrial__motion__planner__testutils_1_1BaseCmd.html

Functions for setting and getting start and goal configurations, planning group, and scaling factors.

```APIDOC
## Member Function Documentation

## ◆ getGoalConfiguration() [1/2]
```cpp
template<class StartType , class GoalType >
GoalType & pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::getGoalConfiguration ()
```
inline
Definition at line 100 of file basecmd.h.

## ◆ getGoalConfiguration() [2/2]
```cpp
template<class StartType , class GoalType >
const GoalType & pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::getGoalConfiguration () const
```
inline
Definition at line 106 of file basecmd.h.

## ◆ getStartConfiguration() [1/2]
```cpp
template<class StartType , class GoalType >
StartType & pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::getStartConfiguration ()
```
inline
Definition at line 88 of file basecmd.h.

## ◆ getStartConfiguration() [2/2]
```cpp
template<class StartType , class GoalType >
const StartType & pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::getStartConfiguration () const
```
inline
Definition at line 94 of file basecmd.h.

## ◆ operator=() [1/2]
```cpp
template<class StartType , class GoalType >
BaseCmd& pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::operator= (BaseCmd< StartType, GoalType > &&)
```
default noexcept

## ◆ operator=() [2/2]
```cpp
template<class StartType , class GoalType >
BaseCmd& pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::operator= (const BaseCmd< StartType, GoalType > &)
```
default

## ◆ setGoalConfiguration()
```cpp
template<class StartType , class GoalType >
void pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::setGoalConfiguration (GoalType _goal)
```
inline
Definition at line 82 of file basecmd.h.

## ◆ setStartConfiguration()
```cpp
template<class StartType , class GoalType >
void pilz_industrial_motion_planner_testutils::BaseCmd< StartType, GoalType >::setStartConfiguration (StartType _start)
```
inline
Definition at line 76 of file basecmd.h.
```

--------------------------------

### Database Connection and Setup

Source: https://moveit.picknik.ai/humble/api/html/save__to__warehouse_8cpp_source.html

Establishes a database connection using provided parameters and checks for successful connection. Returns an error if connection fails.

```cpp
warehouse_ros::DatabaseConnection::Ptr conn = moveit_warehouse::loadDatabase(node);
if (vm.count("host") && vm.count("port"))
conn->setParams(vm["host"].as<std::string>(), vm["port"].as<std::size_t>());
if (!conn->connect())
return 1;
```

--------------------------------

### Setup Servo Status Subscriber

Source: https://moveit.picknik.ai/humble/api/html/servo__launch__test__common_8hpp_source.html

Sets up a subscriber to the servo status topic. This is used to verify that the servo has started or stopped.

```cpp
// Status sub (we need this to check that we've started / stopped)
  sub_servo_status_ = node_->create_subscription<std_msgs::msg::Int8>(
 resolveServoTopicName(servo_parameters_->status_topic), rclcpp::SystemDefaultsQoS(),
 [this](const std_msgs::msg::Int8::ConstSharedPtr& msg) { return statusCB(msg); });
 return true;
}
```

--------------------------------

### SetUp

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__servo_1_1ServoFixture.html

Sets up the testing environment for the ServoFixture.

```APIDOC
## SetUp()

### Description
Initializes the testing environment for the `ServoFixture`. This method is part of the testing framework and is called before each test.

### Signature
`void moveit_servo::ServoFixture::SetUp() override`
```

--------------------------------

### SetUp()

Source: https://moveit.picknik.ai/humble/api/html/classCollisionDetectorPandaTest.html

The SetUp() method is called before each test case to initialize the test environment. It is marked as inline, override, and protected.

```APIDOC
## SetUp()

template<class CollisionAllocatorType >
| void CollisionDetectorPandaTest< CollisionAllocatorType >::SetUp  | ( | | ) | 

### Description
Initializes the test environment before each test case.

### Method
`void SetUp()`

### Access
`protected`

### Definition
`test_collision_common_panda.h` (line 75)
```

--------------------------------

### Check Dependencies and Prompt User

Source: https://moveit.picknik.ai/humble/api/html/configuration__files__widget_8cpp_source.html

Verifies if required setup steps have been completed and displays warnings or prompts the user accordingly. It uses a QMessageBox to show dependency messages and allows the user to confirm or cancel the operation.

```cpp
bool ConfigurationFilesWidget::checkDependencies()
{
std::vector<std::string> dependencies = setup_step_.getIncompleteWarnings();
bool required_actions = false;

// Note that MSA 1.0 required that you have valid author information before proceedings, and if not,
// set required_actions to true here. We ignore this for now.

// Display all accumumlated errors:
if (!dependencies.empty())
{
// Create a dependency message
QString dep_message;
if (!required_actions)
{
dep_message = "Some setup steps have not been completed. None of the steps are required, but here is a reminder "
"of what was not filled in, just in case something was forgotten:<br /><ul>";
}
else
{
dep_message = "Some setup steps have not been completed. Please fix the required steps (printed in bold), "
"otherwise the setup cannot be completed:<br /><ul>";
}

for (const auto& dependency : dependencies)
{
dep_message.append("<li>").append(QString::fromStdString(dependency)).append("</li>");
}

if (!required_actions)
{
dep_message.append("</ul><br/>Press Ok to continue generating files.");
if (QMessageBox::question(this, "Incomplete MoveIt Setup Assistant Steps", dep_message,
QMessageBox::Ok | QMessageBox::Cancel) == QMessageBox::Cancel)
{
return false; // abort
}
}
else
{
QMessageBox::warning(this, "Incomplete MoveIt Setup Assistant Steps", dep_message);
return false;
}
}

return true;
}
```

--------------------------------

### State Monitor Management

Source: https://moveit.picknik.ai/humble/api/html/classplanning__scene__monitor_1_1PlanningSceneMonitor.html

Functions to manage the CurrentStateMonitor, including getting its instance, starting, stopping, and updating the scene with the current state.

```APIDOC
## State Monitor Management

### Get State Monitor

```
const CurrentStateMonitorPtr & getStateMonitor() const
```

Gets the stored instance of the stored current state monitor.

### Get State Monitor (Non-Const)

```
CurrentStateMonitorPtr & getStateMonitorNonConst()
```

Gets the stored instance of the stored current state monitor (non-const version).

### Update Frame Transforms

```
void updateFrameTransforms()
```

Updates the transforms for the frames that are not part of the kinematic model using tf. Examples of these frames are the "map" and "odom_combined" transforms. This function is automatically called when data that uses transforms is received. However, this function should also be called before starting a planning request, for example.

### Start State Monitor

```
void startStateMonitor(const std::string &joint_states_topic=DEFAULT_JOINT_STATES_TOPIC, const std::string &attached_objects_topic=DEFAULT_ATTACHED_COLLISION_OBJECT_TOPIC)
```

Starts the current state monitor.

### Stop State Monitor

```
void stopStateMonitor()
```

Stops the state monitor.

### Update Scene with Current State

```
void updateSceneWithCurrentState(bool skip_update_if_locked=false)
```

Updates the scene using the monitored state. This function is automatically called when an update to the current state is received (if startStateMonitor() has been called). The updates are throttled to a maximum update frequency however, which is set by setStateUpdateFrequency().
```

--------------------------------

### getName

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1app_1_1Launches.html

Returns the name of this setup step.

```APIDOC
## getName()

### Description
Returns the name of the setup step.

### Method
GET

### Endpoint
`/setup/step/name`

### Response
#### Success Response (200)
- **name** (string) - The name of the setup step.

### Response Example
```json
{
  "name": "Launches"
}
```
```

--------------------------------

### Get Number of Free Trajectory Points

Source: https://moveit.picknik.ai/humble/api/html/chomp__trajectory_8h_source.html

Calculates and returns the number of points within the defined start and end indices of the trajectory.

```cpp
inline size_t ChompTrajectory::getNumFreePoints() const
{
  return (end_index_ - start_index_) + 1;
}
```

--------------------------------

### ompl_simple_setup_

Source: https://moveit.picknik.ai/humble/api/html/structompl__interface_1_1ModelBasedPlanningContextSpecification.html

Pointer to the OMPL SimpleSetup object.

```APIDOC
## ◆ ompl_simple_setup_
og::SimpleSetupPtr ompl_interface::ModelBasedPlanningContextSpecification::ompl_simple_setup_
---
Definition at line 72 of file model_based_planning_context.h.
```

--------------------------------

### Get Free Trajectory Block

Source: https://moveit.picknik.ai/humble/api/html/chomp__trajectory_8h_source.html

Retrieves a block representing the segment of the trajectory defined by the start and end indices. This is the portion that CHOMP will optimize.

```cpp
inline Eigen::Block<Eigen::MatrixXd, Eigen::Dynamic, Eigen::Dynamic> ChompTrajectory::getFreeTrajectoryBlock()
{
  return trajectory_.block(start_index_, 0, getNumFreePoints(), getNumJoints());
}
```

--------------------------------

### isReady

Source: https://moveit.picknik.ai/humble/api/html/classmoveit__setup_1_1SetupStep.html

Checks if the setup step has all the necessary data configured to proceed.

```APIDOC
## isReady

### Description
Return true if the data necessary to proceed with this step has been configured. More...

### Method
virtual bool isReady () const

### Remarks
This method can be reimplemented by derived classes to provide custom readiness checks.
```

--------------------------------

### SetUp (Multiple Overloads)

Source: https://moveit.picknik.ai/humble/api/html/functions_func_s.html

Sets up various testing and configuration components.

```APIDOC
## SetUp()

### Description
This function is overloaded and used to set up various components across different test fixtures and classes, including collision detection environments, planning tests, robot configurations, and more.

### Method
Not specified (likely a C++ method call)

### Endpoint
N/A

### Parameters
None explicitly documented.

### Response
Returns various types depending on the context, such as `CollisionDetectionEnvTest`, `CollisionDetectorPandaTest< CollisionAllocatorType >`, `CollisionDetectorTest< CollisionAllocatorType >`, `CollisionDetectorTests`, `CommandPlannerTest`, `ConstrainedPlanningTestFixture`, `ControllersTest`, `DistanceFieldCollisionDetectionTester`, `FloatingJointRobot`, `IntegrationTestCommandListManager`, `IntegrationTestCommandPlanning`, `IntegrationTestPlanComponentBuilder`, `IntegrationTestSequenceAction`, `IntegrationTestSequenceService`, `JointLimitsAggregator`, `JointLimitsContainerTest`, `KinematicsTest`, `LoadPlanningModelsPr2`, `MoveGroupTestFixture`, `moveit::planning_interface::MoveItCppTest`, `moveit_cpp::MoveItCppTest`, `moveit_servo::PoseTrackingFixture`, `moveit_servo::ServoFixture`, `moveit_setup::MoveItSetupTest`, `OneRobot`, `PerceptionTest`, `PickPlaceTestFixture`, `pilz_extensions_tests::JointLimitTest`, `pilz_industrial_motion_planner::GetSolverTipFrameIntegrationTest`, `pilz_industrial_motion_planner::GetSolverTipFrameTest`, `PlanningContextLoadersTest`, `PlanningContextTest< T >`, `PlanningSceneMonitorTest`, `RobotTrajectoryTestFixture`, `SphericalRobot`, `SRDFTest`.
```

--------------------------------

### Launch Rviz with MoveIt Grasps

Source: https://moveit.picknik.ai/humble/doc/examples/moveit_grasps/moveit_grasps_tutorial.html

Start Rviz with the MoveIt Grasps configuration to visualize grasps and related data. The default setup uses a two-finger gripper.

```bash
roslaunch moveit_grasps rviz.launch
```
Tokens:
Raw