kobuki::Firmware Class Reference

#include <firmware.hpp>

Inheritance diagram for kobuki::Firmware:

Classes
struct	Data

Public Member Functions
int	checkMajorVersion () const
int	checkRecommendedVersion () const
bool	constrain ()
bool	deserialise (ecl::PushAndPop< unsigned char > &byteStream)
	Firmware ()
int	majorVersion () const
int	minorVersion () const
int	patchVersion () const
bool	serialise (ecl::PushAndPop< unsigned char > &byteStream)
void	showMe ()
const uint32_t &	version () const
Public Member Functions inherited from packet_handler::payloadBase
	payloadBase (const bool is_dynamic_=false, const unsigned char length_=0)
virtual	~payloadBase ()

Static Public Attributes
static const uint32_t	COMPATIBLE_MAJOR_VERSION = 1
static const std::vector< uint32_t >	RECOMMENDED_VERSIONS = { 0x010104, 0x010200 }

Private Attributes
Data	data

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

Detailed Description

Definition at line 36 of file firmware.hpp.

Constructor & Destructor Documentation

kobuki::Firmware::Firmware ( )

inline

Definition at line 42 of file firmware.hpp.

Member Function Documentation

int kobuki::Firmware::checkMajorVersion

(

)

const

Definition at line 87 of file firmware.cpp.

int kobuki::Firmware::checkRecommendedVersion

(

)

const

Definition at line 95 of file firmware.cpp.

bool kobuki::Firmware::constrain ( )

inline

Definition at line 56 of file firmware.hpp.

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

virtual

Implements packet_handler::payloadBase.

Definition at line 44 of file firmware.cpp.

int kobuki::Firmware::majorVersion ( ) const

inline

Definition at line 66 of file firmware.hpp.

int kobuki::Firmware::minorVersion ( ) const

inline

Definition at line 67 of file firmware.hpp.

int kobuki::Firmware::patchVersion ( ) const

inline

Definition at line 68 of file firmware.hpp.

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

inlinevirtual

Implements packet_handler::payloadBase.

Definition at line 45 of file firmware.hpp.

void kobuki::Firmware::showMe ( )

inline

Definition at line 61 of file firmware.hpp.

const uint32_t& kobuki::Firmware::version ( ) const

inline

Definition at line 65 of file firmware.hpp.

Member Data Documentation

const uint32_t kobuki::Firmware::COMPATIBLE_MAJOR_VERSION = 1

static

Definition at line 39 of file firmware.hpp.

Data kobuki::Firmware::data

private

Definition at line 77 of file firmware.hpp.

const std::vector< uint32_t > kobuki::Firmware::RECOMMENDED_VERSIONS = { 0x010104, 0x010200 }

static

Definition at line 40 of file firmware.hpp.

---

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

• firmware.hpp
• firmware.cpp