aikido::control::ros::RosJointModeCommandClient Class Reference

This class uses actionlib to command an action of the type pr_control_msgs/JointModeCommandAction. More...

#include <aikido/control/ros/RosJointModeCommandClient.hpp>

Public Member Functions
	RosJointModeCommandClient (const ::ros::NodeHandle &node, const std::string &serverName, const std::vector< std::string > jointNames, const std::chrono::milliseconds connectionTimeout=std::chrono::milliseconds{1000}, const std::chrono::milliseconds connectionPollingPeriod=std::chrono::milliseconds{20})
	Constructor. More...
virtual	~RosJointModeCommandClient ()
std::future< int >	execute (const std::vector< hardware_interface::JointCommandModes > &goal)
	Send command to ROS server for execution. More...
void	step ()
void	cancel ()
	Cancel current command. More...

Private Types
using	JointModeCommandActionClient = actionlib::ActionClient< pr_control_msgs::JointModeCommandAction >
using	GoalHandle = JointModeCommandActionClient::GoalHandle

Private Member Functions
void	transitionCallback (GoalHandle handle)

Private Attributes
const ::ros::NodeHandle	mNode
::ros::CallbackQueue	mCallbackQueue
JointModeCommandActionClient	mClient
JointModeCommandActionClient::GoalHandle	mGoalHandle
std::vector< std::string >	mJointNames
std::chrono::milliseconds	mConnectionTimeout
std::chrono::milliseconds	mConnectionPollingPeriod
bool	mInProgress
std::unique_ptr< std::promise< int > >	mPromise
std::mutex	mMutex
	Manages access to mInProgress, mPromise. More...

Detailed Description

This class uses actionlib to command an action of the type pr_control_msgs/JointModeCommandAction.

It specifies a target joint mode command and sends it to the ROS server for setting

Member Typedef Documentation

GoalHandle

using aikido::control::ros::RosJointModeCommandClient::GoalHandle = JointModeCommandActionClient::GoalHandle

private

JointModeCommandActionClient

using aikido::control::ros::RosJointModeCommandClient::JointModeCommandActionClient = actionlib::ActionClient<pr_control_msgs::JointModeCommandAction>

private

Constructor & Destructor Documentation

RosJointModeCommandClient()

aikido::control::ros::RosJointModeCommandClient::RosJointModeCommandClient	(	const ::ros::NodeHandle &	node,
		const std::string &	serverName,
		const std::vector< std::string >	jointNames,
		const std::chrono::milliseconds	connectionTimeout = std::chrono::milliseconds{1000},
		const std::chrono::milliseconds	connectionPollingPeriod = std::chrono::milliseconds{20}
	)

Constructor.

Parameters

[in]	node	ROS node handle for action client.
[in]	serverName	Name of the server to send mode target to.
[in]	jointNames	The names of the joints to set mode targets for
[in]	connectionTimeout	Timeout for server connection.
[in]	connectionPollingPeriod	Polling period for server connection.

~RosJointModeCommandClient()

virtual aikido::control::ros::RosJointModeCommandClient::~RosJointModeCommandClient ( )

virtual

Member Function Documentation

cancel()

void aikido::control::ros::RosJointModeCommandClient::cancel

(

)

Cancel current command.

Should trigger exception for active std::promise

execute()

std::future<int> aikido::control::ros::RosJointModeCommandClient::execute

(

const std::vector< hardware_interface::JointCommandModes > &

goal

)

Send command to ROS server for execution.

Parameters

[in]	goal	target joint command mode of target positions for each joint
[in]	timeout	How long until command should expire

step()

void aikido::control::ros::RosJointModeCommandClient::step

(

)

To be executed on a separate thread. Regularly checks for the completion of a sent command.

transitionCallback()

void aikido::control::ros::RosJointModeCommandClient::transitionCallback ( GoalHandle  handle )

private

Member Data Documentation

mCallbackQueue

::ros::CallbackQueue aikido::control::ros::RosJointModeCommandClient::mCallbackQueue

private

mClient

JointModeCommandActionClient aikido::control::ros::RosJointModeCommandClient::mClient

private

mConnectionPollingPeriod

std::chrono::milliseconds aikido::control::ros::RosJointModeCommandClient::mConnectionPollingPeriod

private

mConnectionTimeout

std::chrono::milliseconds aikido::control::ros::RosJointModeCommandClient::mConnectionTimeout

private

mGoalHandle

JointModeCommandActionClient::GoalHandle aikido::control::ros::RosJointModeCommandClient::mGoalHandle

private

mInProgress

bool aikido::control::ros::RosJointModeCommandClient::mInProgress

private

mJointNames

std::vector<std::string> aikido::control::ros::RosJointModeCommandClient::mJointNames

private

mMutex

std::mutex aikido::control::ros::RosJointModeCommandClient::mMutex

mutableprivate

Manages access to mInProgress, mPromise.

mNode

const ::ros::NodeHandle aikido::control::ros::RosJointModeCommandClient::mNode

private

mPromise

std::unique_ptr<std::promise<int> > aikido::control::ros::RosJointModeCommandClient::mPromise

private