moveit2
The MoveIt Motion Planning Framework for ROS 2.
Public Member Functions | Protected Attributes | List of all members
moveit_setup::srdf_setup::VirtualJoints Class Reference

#include <virtual_joints.hpp>

Inheritance diagram for moveit_setup::srdf_setup::VirtualJoints:
Inheritance graph
[legend]
Collaboration diagram for moveit_setup::srdf_setup::VirtualJoints:
Collaboration graph
[legend]

Public Member Functions

std::string getName () const override
 Returns the name of the setup step. More...
 
std::vector< srdf::Model::VirtualJoint > & getContainer () override
 Returns the reference to the vector in the SRDF. More...
 
InformationFields getInfoField () const override
 Returns the info field associated with this part of the SRDF. More...
 
void onInit () override
 Overridable initialization method. More...
 
void setProperties (srdf::Model::VirtualJoint *vj, const std::string &parent_name, const std::string &child_name, const std::string &joint_type)
 
std::vector< std::string > getLinkNames () const
 
- Public Member Functions inherited from moveit_setup::srdf_setup::SuperSRDFStep< srdf::Model::VirtualJoint >
srdf::Model::VirtualJoint * find (const std::string &name)
 Return a pointer to an item with the given name if it exists, otherwise null. More...
 
srdf::Model::VirtualJoint * create (const std::string &name)
 Create an item with the given name and return the pointer. More...
 
srdf::Model::VirtualJoint * rename (const std::string &old_name, const std::string &new_name)
 Renames an item and returns a pointer to the item. More...
 
bool remove (const std::string &name)
 Delete an item with the given name from the list. More...
 
srdf::Model::VirtualJoint * get (const std::string &name, const std::string &old_name="")
 Get a pointer to an item with the given name, creating if necessary. If old_name is provided (and is different) will rename the given item. More...
 
- Public Member Functions inherited from moveit_setup::srdf_setup::SRDFStep
bool isReady () const override
 Return true if the data necessary to proceed with this step has been configured. More...
 
bool hasGroups () const
 
- Public Member Functions inherited from moveit_setup::SetupStep
 SetupStep ()=default
 
 SetupStep (const SetupStep &)=default
 
 SetupStep (SetupStep &&)=default
 
SetupStepoperator= (const SetupStep &)=default
 
SetupStepoperator= (SetupStep &&)=default
 
virtual ~SetupStep ()=default
 
void initialize (const rclcpp::Node::SharedPtr &parent_node, const DataWarehousePtr &config_data)
 Called after construction to initialize the step. More...
 
const rclcpp::Logger & getLogger () const
 Makes a namespaced logger for this step available to the widget. More...
 

Protected Attributes

std::shared_ptr< URDFConfigurdf_config_
 
- Protected Attributes inherited from moveit_setup::srdf_setup::SRDFStep
std::shared_ptr< SRDFConfigsrdf_config_
 
- Protected Attributes inherited from moveit_setup::SetupStep
DataWarehousePtr config_data_
 
rclcpp::Node::SharedPtr parent_node_
 
std::shared_ptr< rclcpp::Logger > logger_
 

Detailed Description

Definition at line 45 of file virtual_joints.hpp.

Member Function Documentation

◆ getContainer()

std::vector<srdf::Model::VirtualJoint>& moveit_setup::srdf_setup::VirtualJoints::getContainer ( )
inlineoverridevirtual

Returns the reference to the vector in the SRDF.

Implements moveit_setup::srdf_setup::SuperSRDFStep< srdf::Model::VirtualJoint >.

Definition at line 53 of file virtual_joints.hpp.

◆ getInfoField()

InformationFields moveit_setup::srdf_setup::VirtualJoints::getInfoField ( ) const
inlineoverridevirtual

Returns the info field associated with this part of the SRDF.

Implements moveit_setup::srdf_setup::SuperSRDFStep< srdf::Model::VirtualJoint >.

Definition at line 58 of file virtual_joints.hpp.

◆ getLinkNames()

std::vector<std::string> moveit_setup::srdf_setup::VirtualJoints::getLinkNames ( ) const
inline

Definition at line 68 of file virtual_joints.hpp.

◆ getName()

std::string moveit_setup::srdf_setup::VirtualJoints::getName ( ) const
inlineoverridevirtual

Returns the name of the setup step.

Implements moveit_setup::SetupStep.

Definition at line 48 of file virtual_joints.hpp.

◆ onInit()

void moveit_setup::srdf_setup::VirtualJoints::onInit ( )
overridevirtual

Overridable initialization method.

Reimplemented from moveit_setup::srdf_setup::SRDFStep.

Definition at line 43 of file virtual_joints.cpp.

Here is the call graph for this function:

◆ setProperties()

void moveit_setup::srdf_setup::VirtualJoints::setProperties ( srdf::Model::VirtualJoint *  vj,
const std::string &  parent_name,
const std::string &  child_name,
const std::string &  joint_type 
)

Definition at line 49 of file virtual_joints.cpp.

Member Data Documentation

◆ urdf_config_

std::shared_ptr<URDFConfig> moveit_setup::srdf_setup::VirtualJoints::urdf_config_
protected

Definition at line 74 of file virtual_joints.hpp.


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