guWhiteboard::DifferentialRobotControlStatus Class Reference

Class for controlling differential robots Defines whiteboard message. More...

#include <DifferentialRobotControlStatus.hpp>

Inheritance diagram for guWhiteboard::DifferentialRobotControlStatus:

Collaboration diagram for guWhiteboard::DifferentialRobotControlStatus:

Public Member Functions
	DifferentialRobotControlStatus ()
	Designated constructor. More...
	DifferentialRobotControlStatus (const std::string &name)
	String constructor. More...
std::string	description ()
	get message description More...
void	from_string (std::string str)
	string conversion More...
bool	operator== (const DifferentialRobotControlStatus &s)
	override equality operator so we can compare instances More...
void	stop ()
	Abstraction for a stop. More...
Public Member Functions inherited from wb_differential_robot
	PROPERTY (struct wb_kinematic_motor, left_motor) PROPERTY(struct wb_kinematic_motor
	kinematic settings for the left motor More...
right_motor	wb_differential_robot ()
	Default constructor. More...

Detailed Description

Class for controlling differential robots Defines whiteboard message.

Definition at line 17 of file DifferentialRobotControlStatus.hpp.

Constructor & Destructor Documentation

DifferentialRobotControlStatus() [1/2]

guWhiteboard::DifferentialRobotControlStatus::DifferentialRobotControlStatus ( )

inline

Designated constructor.

Definition at line 20 of file DifferentialRobotControlStatus.hpp.

DifferentialRobotControlStatus() [2/2]

guWhiteboard::DifferentialRobotControlStatus::DifferentialRobotControlStatus ( const std::string &  name )

inline

String constructor.

Definition at line 24 of file DifferentialRobotControlStatus.hpp.

References from_string().

Member Function Documentation

description()

std::string guWhiteboard::DifferentialRobotControlStatus::description ( )

inline

get message description

Definition at line 29 of file DifferentialRobotControlStatus.hpp.

from_string()

void guWhiteboard::DifferentialRobotControlStatus::from_string ( std::string  str )

inline

string conversion

Definition at line 41 of file DifferentialRobotControlStatus.hpp.

Referenced by DifferentialRobotControlStatus().

operator==()

bool guWhiteboard::DifferentialRobotControlStatus::operator== ( const DifferentialRobotControlStatus &  s )

inline

override equality operator so we can compare instances

Definition at line 61 of file DifferentialRobotControlStatus.hpp.

stop()

void guWhiteboard::DifferentialRobotControlStatus::stop ( )

inline

Abstraction for a stop.

Definition at line 80 of file DifferentialRobotControlStatus.hpp.

---

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

• typeClassDefs/DifferentialRobotControlStatus.hpp