Public Member Functions | Private Attributes | List of all members
actionlib::GoalIDGenerator Class Reference

#include <goal_id_generator.h>

Public Member Functions

actionlib_msgs::GoalID generateID ()
 Generates a unique ID. More...
 
 GoalIDGenerator ()
 
 GoalIDGenerator (const std::string &name)
 
void setName (const std::string &name)
 

Private Attributes

std::string name_
 

Detailed Description

Definition at line 49 of file goal_id_generator.h.

Constructor & Destructor Documentation

actionlib::GoalIDGenerator::GoalIDGenerator ( )

Create a generator that prepends the fully qualified node name to the Goal ID

Definition at line 45 of file goal_id_generator.cpp.

actionlib::GoalIDGenerator::GoalIDGenerator ( const std::string &  name)
Parameters
nameUnique name to prepend to the goal id. This will generally be a fully qualified node name.

Definition at line 50 of file goal_id_generator.cpp.

Member Function Documentation

actionlib_msgs::GoalID actionlib::GoalIDGenerator::generateID ( )

Generates a unique ID.

Returns
A unique GoalID for this action

Definition at line 60 of file goal_id_generator.cpp.

void actionlib::GoalIDGenerator::setName ( const std::string &  name)
Parameters
nameSet the name to prepend to the goal id. This will generally be a fully qualified node name.

Definition at line 55 of file goal_id_generator.cpp.

Member Data Documentation

std::string actionlib::GoalIDGenerator::name_
private

Definition at line 76 of file goal_id_generator.h.


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


actionlib
Author(s): Eitan Marder-Eppstein, Vijay Pradeep, Mikael Arguedas
autogenerated on Tue Sep 3 2019 03:41:41