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<>
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

Definition at line 42 of file firmware.hpp.

Constructor & Destructor Documentation

Firmware()

kobuki::Firmware::Firmware ( )

inline

Definition at line 56 of file firmware.hpp.

Member Function Documentation

checkMajorVersion()

int kobuki::Firmware::checkMajorVersion

(

)

const

Definition at line 91 of file firmware.cpp.

checkRecommendedVersion()

int kobuki::Firmware::checkRecommendedVersion

(

)

const

Definition at line 99 of file firmware.cpp.

constrain()

bool kobuki::Firmware::constrain ( )

inline

Definition at line 70 of file firmware.hpp.

deserialise()

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

virtual

Implements packet_handler::payloadBase.

Definition at line 48 of file firmware.cpp.

majorVersion()

int kobuki::Firmware::majorVersion ( ) const

inline

Definition at line 80 of file firmware.hpp.

minorVersion()

int kobuki::Firmware::minorVersion ( ) const

inline

Definition at line 81 of file firmware.hpp.

patchVersion()

int kobuki::Firmware::patchVersion ( ) const

inline

Definition at line 82 of file firmware.hpp.

serialise()

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

inlinevirtual

Implements packet_handler::payloadBase.

Definition at line 59 of file firmware.hpp.

showMe()

void kobuki::Firmware::showMe ( )

inline

Definition at line 75 of file firmware.hpp.

version()

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

inline

Definition at line 79 of file firmware.hpp.

Member Data Documentation

COMPATIBLE_MAJOR_VERSION

const uint32_t kobuki::Firmware::COMPATIBLE_MAJOR_VERSION = 1

static

Definition at line 53 of file firmware.hpp.

data

Data kobuki::Firmware::data

private

Definition at line 91 of file firmware.hpp.

RECOMMENDED_VERSIONS

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

static

Definition at line 54 of file firmware.hpp.

---

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

• firmware.hpp
• firmware.cpp