VMXZero Class Reference

Top-level Library Class providing access to all VMXzero functionality. More...

#include <VMXZero.h>

Public Member Functions
	VMXZero (bool realtime, uint8_t ahrs_update_rate_hz)
bool	IsOpen ()
vmx::AHRS &	getAHRS ()
	Returns a reference to the singleton AHRS object providing access to VMXzero IMU functionality. More...
VMXTime &	getTime ()
	Returns a reference to the singleton VMXTime object providing access to VMXzero Time functionality. More...
VMXIO &	getIO ()
	Returns a reference to the singleton VMXIO object providing access to VMXzero IO functionality. More...
VMXTeddy &	getTeddy ()
	Returns a reference to the singleton VMXTeddy object providing access to VMXzero Teddy functionality. More...
VMXPower &	getPower ()
	Returns a reference to the singleton VMXPower object providing access to VMXzero Power functionality. More...
VMXVersion &	getVersion ()
	Returns a reference to the singleton VMXVersion object providing access to VMXzero Version functionality. More...
VMXThread &	getThread ()
	Returns a reference to the singleton VMXThread object providing access to VMXzero Threading functionality. More...
bool	registerShutdownHandler (void(*termination_func)(void))
	Registers a termination handler, invoked when VMXPi instance is terminated, but before resources are released. More...
bool	registerFinalShutdownHandler (void(*termination_func)(void))
	Registers a termination handler, invoked when VMXPi instance is terminated, but only after all resources are released. More...
bool	getPerformanceLogging ()
	Selective Enabling/Disabling of Summary Performance statistics. More...
void	setPerformanceLogging (bool enable)

Static Public Member Functions
static VMXZero *	getInstance ()

Public Attributes
vmx::AHRS	ahrs
	The AHRS object providing access to VMXzero IMU functionality. More...
VMXTime	time
	The VMXTime object providing access to VMXzero Time functionality. More...
VMXIO	io
	The VMXIO object providing access to VMXzero IO functionality. More...
VMXTeddy	teddy
	The VMXTeddy object providing access to VMXzero Teddy functionality. More...
VMXPower	power
	The VMXPower object providing access to VMXzero Power functionality. More...
VMXVersion	version
	The VMXVersion object providing access to VMXzero Version functionality. More...
VMXThread	thread
	The VMXThread object providing access to VMXzero Threading functionality. More...

Detailed Description

Top-level Library Class providing access to all VMXzero functionality.

Member Function Documentation

getAHRS()

vmx::AHRS& VMXZero::getAHRS ( )

inline

Returns a reference to the singleton AHRS object providing access to VMXzero IMU functionality.

getIO()

VMXIO& VMXZero::getIO ( )

inline

Returns a reference to the singleton VMXIO object providing access to VMXzero IO functionality.

getPerformanceLogging()

bool VMXZero::getPerformanceLogging

(

)

Selective Enabling/Disabling of Summary Performance statistics.

getPower()

VMXPower& VMXZero::getPower ( )

inline

Returns a reference to the singleton VMXPower object providing access to VMXzero Power functionality.

getTeddy()

VMXTeddy& VMXZero::getTeddy ( )

inline

Returns a reference to the singleton VMXTeddy object providing access to VMXzero Teddy functionality.

getThread()

VMXThread& VMXZero::getThread ( )

inline

Returns a reference to the singleton VMXThread object providing access to VMXzero Threading functionality.

getTime()

VMXTime& VMXZero::getTime ( )

inline

Returns a reference to the singleton VMXTime object providing access to VMXzero Time functionality.

getVersion()

VMXVersion& VMXZero::getVersion ( )

inline

Returns a reference to the singleton VMXVersion object providing access to VMXzero Version functionality.

registerFinalShutdownHandler()

bool VMXZero::registerFinalShutdownHandler

(

void(*)(void)

termination_func

)

Registers a termination handler, invoked when VMXPi instance is terminated, but only after all resources are released.

Only a single final shutdown handler may be registered.

registerShutdownHandler()

bool VMXZero::registerShutdownHandler

(

void(*)(void)

termination_func

)

Registers a termination handler, invoked when VMXPi instance is terminated, but before resources are released.

Termination functions are invoked in the reverse order of registration.

Member Data Documentation

ahrs

vmx::AHRS VMXZero::ahrs

The AHRS object providing access to VMXzero IMU functionality.

io

VMXIO VMXZero::io

The VMXIO object providing access to VMXzero IO functionality.

power

VMXPower VMXZero::power

The VMXPower object providing access to VMXzero Power functionality.

teddy

VMXTeddy VMXZero::teddy

The VMXTeddy object providing access to VMXzero Teddy functionality.

thread

VMXThread VMXZero::thread

The VMXThread object providing access to VMXzero Threading functionality.

time

VMXTime VMXZero::time

The VMXTime object providing access to VMXzero Time functionality.

version

VMXVersion VMXZero::version

The VMXVersion object providing access to VMXzero Version functionality.

---

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

• /home/pi/vmx/vmx-pi/hal/hal_cpp/include/VMXZero.h