uavcan::IAdHocNodeStatusUpdater Class Reference

#include <node_status_provider.hpp>

Inheritance diagram for uavcan::IAdHocNodeStatusUpdater:

Public Member Functions
virtual void	updateNodeStatus ()=0
virtual	~IAdHocNodeStatusUpdater ()

Detailed Description

This optional interface can be implemented by the user in order to update the node status as necessary, immediately before the next NodeStatus message is emitted by NodeStatusProvider.

Definition at line 23 of file node_status_provider.hpp.

Constructor & Destructor Documentation

~IAdHocNodeStatusUpdater()

virtual uavcan::IAdHocNodeStatusUpdater::~IAdHocNodeStatusUpdater ( )

inlinevirtual

Definition at line 39 of file node_status_provider.hpp.

Member Function Documentation

updateNodeStatus()

virtual void uavcan::IAdHocNodeStatusUpdater::updateNodeStatus ( )

pure virtual

This method is invoked by the library from NodeStatusProvider from the library's thread immediately before the next NodeStatus message is transmitted. The application can implement this method to perform node status updates only as necessary. The application is expected to invoke the methods of NodeStatusProvider to update the status from this method. Note that this method is only invoked when publication is happening by the timer event. It will NOT be invoked if the following methods are used to trigger node status publication:

• NodeStatusProvider::startAndPublish()
• NodeStatusProvider::forcePublish()

Implemented in AdHocNodeStatusUpdater.

---

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

• node_status_provider.hpp