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

#include <LocomotionControllerLocalGuidance.hpp>

Public Member Functions

 LocomotionControllerLocalGuidance ()=default
 
 LocomotionControllerLocalGuidance (std::string name, std::string mode, std::string subMode)
 
virtual ~LocomotionControllerLocalGuidance ()=default
 
std::string toString () const
 

Public Attributes

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

Friends

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

Constructor & Destructor Documentation

navigation_common::LocomotionControllerLocalGuidance::LocomotionControllerLocalGuidance ( )
default

Constructor.

navigation_common::LocomotionControllerLocalGuidance::LocomotionControllerLocalGuidance ( std::string  name,
std::string  mode,
std::string  subMode 
)

Constructor.

Parameters
namename.
modemode.
subModesub-mode.
virtual navigation_common::LocomotionControllerLocalGuidance::~LocomotionControllerLocalGuidance ( )
virtualdefault

Destructor.

Member Function Documentation

std::string navigation_common::LocomotionControllerLocalGuidance::toString ( ) const

To String helper.

Returns
string describing the controller.

Friends And Related Function Documentation

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

Inequality operator.

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

Equality operator.

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

Member Data Documentation

std::string navigation_common::LocomotionControllerLocalGuidance::mode_

Mode.

std::string navigation_common::LocomotionControllerLocalGuidance::name_

Name.

std::string navigation_common::LocomotionControllerLocalGuidance::subMode_

Submode.


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