moveit_setup::SetupStep Class Reference

Contains all of the non-GUI code necessary for doing one "screen" worth of setup. More...

#include <setup_step.hpp>

Inheritance diagram for moveit_setup::SetupStep:

Public Member Functions
	SetupStep ()=default
	SetupStep (const SetupStep &)=default
	SetupStep (SetupStep &&)=default
SetupStep &	operator= (const SetupStep &)=default
SetupStep &	operator= (SetupStep &&)=default
virtual	~SetupStep ()=default
void	initialize (const rclcpp::Node::SharedPtr &parent_node, const DataWarehousePtr &config_data)
	Called after construction to initialize the step.
virtual void	onInit ()
	Overridable initialization method.
virtual std::string	getName () const =0
	Returns the name of the setup step.
virtual bool	isReady () const
	Return true if the data necessary to proceed with this step has been configured.
const rclcpp::Logger &	getLogger () const
	Makes a namespaced logger for this step available to the widget.

Protected Attributes
DataWarehousePtr	config_data_
rclcpp::Node::SharedPtr	parent_node_
std::shared_ptr< rclcpp::Logger >	logger_

Detailed Description

Contains all of the non-GUI code necessary for doing one "screen" worth of setup.

Definition at line 46 of file setup_step.hpp.

Constructor & Destructor Documentation

SetupStep() [1/3]

moveit_setup::SetupStep::SetupStep ( )

default

SetupStep() [2/3]

moveit_setup::SetupStep::SetupStep ( const SetupStep &  )

default

SetupStep() [3/3]

moveit_setup::SetupStep::SetupStep ( SetupStep &&  )

default

~SetupStep()

virtual moveit_setup::SetupStep::~SetupStep ( )

virtualdefault

Member Function Documentation

getLogger()

const rclcpp::Logger & moveit_setup::SetupStep::getLogger ( ) const

inline

Makes a namespaced logger for this step available to the widget.

Definition at line 91 of file setup_step.hpp.

Here is the caller graph for this function:

getName()

virtual std::string moveit_setup::SetupStep::getName ( ) const

pure virtual

Returns the name of the setup step.

Implemented in moveit_setup::app::Launches, moveit_setup::app::Perception, moveit_setup::controllers::MoveItControllers, moveit_setup::controllers::ROS2Controllers, moveit_setup::controllers::UrdfModifications, moveit_setup::core::AuthorInformation, moveit_setup::core::ConfigurationFiles, moveit_setup::core::StartScreen, moveit_setup::simulation::Simulation, moveit_setup::srdf_setup::DefaultCollisions, moveit_setup::srdf_setup::EndEffectors, moveit_setup::srdf_setup::PassiveJoints, moveit_setup::srdf_setup::PlanningGroups, moveit_setup::srdf_setup::RobotPoses, and moveit_setup::srdf_setup::VirtualJoints.

Here is the caller graph for this function:

initialize()

void moveit_setup::SetupStep::initialize ( const rclcpp::Node::SharedPtr &  parent_node, const DataWarehousePtr &  config_data  )

inline

Called after construction to initialize the step.

Parameters

parent_node

Shared pointer to the parent node

Definition at line 60 of file setup_step.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

isReady()

virtual bool moveit_setup::SetupStep::isReady ( ) const

inlinevirtual

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

Reimplemented in moveit_setup::app::Launches, moveit_setup::app::Perception, moveit_setup::controllers::Controllers, moveit_setup::controllers::UrdfModifications, moveit_setup::core::AuthorInformation, moveit_setup::simulation::Simulation, moveit_setup::srdf_setup::EndEffectors, moveit_setup::srdf_setup::RobotPoses, and moveit_setup::srdf_setup::SRDFStep.

Definition at line 83 of file setup_step.hpp.

Here is the caller graph for this function:

onInit()

virtual void moveit_setup::SetupStep::onInit ( )

inlinevirtual

Overridable initialization method.

Reimplemented in moveit_setup::app::Launches, moveit_setup::app::Perception, moveit_setup::controllers::MoveItControllers, moveit_setup::controllers::ROS2Controllers, moveit_setup::controllers::UrdfModifications, moveit_setup::core::AuthorInformation, moveit_setup::core::ConfigurationFiles, moveit_setup::core::StartScreen, moveit_setup::simulation::Simulation, moveit_setup::srdf_setup::EndEffectors, moveit_setup::srdf_setup::PlanningGroups, moveit_setup::srdf_setup::RobotPoses, moveit_setup::srdf_setup::SRDFStep, and moveit_setup::srdf_setup::VirtualJoints.

Definition at line 71 of file setup_step.hpp.

Here is the caller graph for this function:

operator=() [1/2]

SetupStep & moveit_setup::SetupStep::operator= ( const SetupStep &  )

default

operator=() [2/2]

SetupStep & moveit_setup::SetupStep::operator= ( SetupStep &&  )

default

Member Data Documentation

config_data_

DataWarehousePtr moveit_setup::SetupStep::config_data_

protected

Definition at line 97 of file setup_step.hpp.

logger_

std::shared_ptr<rclcpp::Logger> moveit_setup::SetupStep::logger_

protected

Definition at line 99 of file setup_step.hpp.

parent_node_

rclcpp::Node::SharedPtr moveit_setup::SetupStep::parent_node_

protected

Definition at line 98 of file setup_step.hpp.

---

The documentation for this class was generated from the following file:

• moveit_setup_assistant/moveit_setup_framework/include/moveit_setup_framework/setup_step.hpp