xbot::Parameters Class Reference

Parameter list and validator for the xbot. More...

#include <parameters.hpp>

Public Member Functions
	Parameters ()
	Default constructor. More...
bool	validate ()
	A validator to ensure the user has supplied correct/sensible parameter values. More...

Public Attributes
double	angular_acceleration_limit
double	angular_deceleration_limit
std::string	base_port
	The serial device port name [/dev/xbot]. More...
bool	enable_acceleration_limiter
	Enable or disable the acceleration limiter [true]. More...
std::string	error_msg
	Provides error messages when parameter validation fails (internal purposes only) More...
double	linear_acceleration_limit
double	linear_deceleration_limit
std::string	sensor_port
std::string	sigslots_namespace
	The first part of a sigslot connection namespace ["/xbot"]. More...
bool	simulation
	Whether to put the motors in loopback mode or not [false]. More...

Detailed Description

Parameter list and validator for the xbot.

Definition at line 35 of file parameters.hpp.

Constructor & Destructor Documentation

xbot::Parameters::Parameters ( )

inline

Default constructor.

Definition at line 38 of file parameters.hpp.

Member Function Documentation

bool xbot::Parameters::validate ( )

inline

A validator to ensure the user has supplied correct/sensible parameter values.

This validates the current parameters and if invalid, puts an error string in error_msg.

Returns

bool : true if valid, false otherwise.

Definition at line 69 of file parameters.hpp.

Member Data Documentation

double xbot::Parameters::angular_acceleration_limit

Definition at line 59 of file parameters.hpp.

double xbot::Parameters::angular_deceleration_limit

Definition at line 60 of file parameters.hpp.

std::string xbot::Parameters::base_port

The serial device port name [/dev/xbot].

Definition at line 51 of file parameters.hpp.

bool xbot::Parameters::enable_acceleration_limiter

Enable or disable the acceleration limiter [true].

Definition at line 55 of file parameters.hpp.

std::string xbot::Parameters::error_msg

Provides error messages when parameter validation fails (internal purposes only)

Definition at line 75 of file parameters.hpp.

double xbot::Parameters::linear_acceleration_limit

Definition at line 57 of file parameters.hpp.

double xbot::Parameters::linear_deceleration_limit

Definition at line 58 of file parameters.hpp.

std::string xbot::Parameters::sensor_port

Definition at line 52 of file parameters.hpp.

std::string xbot::Parameters::sigslots_namespace

The first part of a sigslot connection namespace ["/xbot"].

Definition at line 53 of file parameters.hpp.

bool xbot::Parameters::simulation

Whether to put the motors in loopback mode or not [false].

Definition at line 54 of file parameters.hpp.

---

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

• parameters.hpp