myolinux Namespace Reference

The main namespace. More...

Namespaces
	bled112
	Contains the BlueGiga client and auxiliary classes (which are not included, because there are too many of them).
	gatt
	Contains the GATT client and auxiliary classes.
	myo
	Contains the Myo client and auxiliary classes.

Classes
class	Serial
	Class for communication over the serial port. More...

Typedefs
using	Buffer = std::vector< unsigned char >
	Buffer used for packing and unpacking packets.

Functions
template<typename T >
Buffer	pack (const T &payload)
	Pack payload.
template<typename T >
T	unpack (const Buffer &buf)
	Unpack payload.

Detailed Description

The main namespace.

It contains all symbols defined in this project, which prevents the pollution of the global scope. Generally it is fine to introduce them into the file scope by a using-directive, as the majority of the library is contained inside the bled112, gatt and myo sub-namespaces.

It directly contains all general helper constructs: Buffer, Serial.

By default it is named myolinux, however to avoid any namespace clashes it can be renamed by defining the MYOLINUX_NAMESPACE at compile time. Please note that programs using a different global namespace name are not compatible, therefore the library has to be distributed with the program in that case.