Class Parameters

Class Documentation

class Parameters

Parameter list and validator for the kobuki.

Public Functions

inline Parameters()

Default constructor.

inline bool validate()

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.

Public Members

std::string device_port

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

std::string sigslots_namespace

The first part of a sigslot connection namespace [“/kobuki”].

bool simulation

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

bool enable_acceleration_limiter

Enable or disable the acceleration limiter [true].

double battery_capacity

Capacity voltage of the battery [16.5V].

double battery_low

Threshold for battery level warnings [14.0V].

double battery_dangerous

Threshold for battery level in danger of depletion [13.2V].

double linear_acceleration_limit
double linear_deceleration_limit
double angular_acceleration_limit
double angular_deceleration_limit
LogLevel log_level

Print to stdout messages for this logging level and above.

std::string error_msg

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