LocalGuidance
A library that generates velocity references to follow a path.
navigation_common::LocomotionController Class Reference

#include <LocomotionController.hpp>

Public Member Functions

 LocomotionController ()=default
 
 LocomotionController (const std::string &name, const std::string &mode)
 
 LocomotionController (const navigation_msgs::LocomotionController &msg)
 
 ~LocomotionController ()=default
 
void fromRos (const navigation_msgs::LocomotionController &msg)
 
navigation_msgs::LocomotionController toRos () const
 
bool hasServiceInterface () const
 
bool isContinuous () const
 
bool takesPoseInput () const
 
bool takesTwistInput () const
 

Public Attributes

std::string name_
 Name. More...
 
std::string mode_
 Mode. More...
 

Static Protected Member Functions

static bool contains (const std::string &string, const std::string &substring)
 

Friends

bool operator== (const LocomotionController &lhs, const LocomotionController &rhs)
 
bool operator!= (const LocomotionController &lhs, const LocomotionController &rhs)
 

Constructor & Destructor Documentation

navigation_common::LocomotionController::LocomotionController ( )
default

Constructor.

navigation_common::LocomotionController::LocomotionController ( const std::string &  name,
const std::string &  mode 
)
explicit

Constructor.

Parameters
namename.
modemode.
navigation_common::LocomotionController::LocomotionController ( const navigation_msgs::LocomotionController msg)
explicit

Constructor.

Parameters
msgros msg.
navigation_common::LocomotionController::~LocomotionController ( )
default

Destructor.

Member Function Documentation

static bool navigation_common::LocomotionController::contains ( const std::string &  string,
const std::string &  substring 
)
staticprotected
void navigation_common::LocomotionController::fromRos ( const navigation_msgs::LocomotionController msg)

Imports a ros msg.

Parameters
msgros msg.
bool navigation_common::LocomotionController::hasServiceInterface ( ) const

Check if this controller has a service or an action interface.

Returns
True if it has a service interface, false if it has an action interface.
bool navigation_common::LocomotionController::isContinuous ( ) const

Check if this controller/mode is continuous or finite.

Returns
True if it is continuous, false if it is finite.
bool navigation_common::LocomotionController::takesPoseInput ( ) const

Check if this controller/mode takes a pose as input.

Returns
True if it uses a pose as input.
bool navigation_common::LocomotionController::takesTwistInput ( ) const

Check if this controller/mode takes a twist as input.

Returns
True if it uses a twist as input.
navigation_msgs::LocomotionController navigation_common::LocomotionController::toRos ( ) const

Exports a ros msg.

Returns
ros msg.

Friends And Related Function Documentation

bool operator!= ( const LocomotionController lhs,
const LocomotionController rhs 
)
friend

Inequality operator.

Returns
true if locomotion controllers have different name or mode.
bool operator== ( const LocomotionController lhs,
const LocomotionController rhs 
)
friend

Equality operator.

Returns
true if both locomotion controllers have same name and mode.

Member Data Documentation

std::string navigation_common::LocomotionController::mode_

Mode.

std::string navigation_common::LocomotionController::name_

Name.


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