kobuki::Current Class Reference

#include <current.hpp>

Inheritance diagram for kobuki::Current:

Classes
struct	Data

Public Member Functions
bool	constrain ()
	Current ()
bool	deserialise (ecl::PushAndPop< unsigned char > &byteStream)
bool	serialise (ecl::PushAndPop< unsigned char > &byteStream)
void	showMe ()
Public Member Functions inherited from packet_handler::payloadBase
	payloadBase (const bool is_dynamic_=false, const unsigned char length_=0)
virtual	~payloadBase ()

Public Attributes
struct kobuki::Current::Data	data
Public Attributes inherited from packet_handler::payloadBase
const bool	is_dynamic
const unsigned char	length
bool	yes

Additional Inherited Members
Protected Member Functions inherited from packet_handler::payloadBase
template<>
void	buildBytes (const float &V, ecl::PushAndPop< unsigned char > &buffer)
template<typename T >
void	buildBytes (const T &V, ecl::PushAndPop< unsigned char > &buffer)
template<>
void	buildVariable (float &V, ecl::PushAndPop< unsigned char > &buffer)
template<typename T >
void	buildVariable (T &V, ecl::PushAndPop< unsigned char > &buffer)

Detailed Description

This comes back in the streamed feedback. It has two values (left and right) indicating the supplied current which can be useful for detecting when the robot is blocked.

Definition at line 45 of file current.hpp.

Constructor & Destructor Documentation

Current()

kobuki::Current::Current ( )

inline

Definition at line 56 of file current.hpp.

Member Function Documentation

constrain()

bool kobuki::Current::constrain ( )

inline

Definition at line 91 of file current.hpp.

deserialise()

bool kobuki::Current::deserialise ( ecl::PushAndPop< unsigned char > &  byteStream )

inlinevirtual

Implements packet_handler::payloadBase.

Definition at line 71 of file current.hpp.

serialise()

bool kobuki::Current::serialise ( ecl::PushAndPop< unsigned char > &  byteStream )

inlinevirtual

Implements packet_handler::payloadBase.

Definition at line 62 of file current.hpp.

showMe()

void kobuki::Current::showMe ( )

inline

Definition at line 96 of file current.hpp.

Member Data Documentation

data

struct kobuki::Current::Data kobuki::Current::data

---

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

• current.hpp