libuav original

Dependents:   UAVCAN UAVCAN_Subscriber

Embed: (wiki syntax)

« Back to documentation index

PanicBroadcaster Class Reference

PanicBroadcaster Class Reference

Helper for broadcasting the message uavcan.protocol.Panic. More...

#include <panic_broadcaster.hpp>

Inherits uavcan::TimerBase.

Public Member Functions

void panic (const char *short_reason_description, MonotonicDuration broadcasting_period=MonotonicDuration::fromMSec(100), const TransferPriority priority=TransferPriority::Default)
 This method does not block and can't fail.
void dontPanic ()
 Stop broadcasting immediately.

Private Member Functions

void startOneShotWithDeadline (MonotonicTime deadline)
 Various ways to start the timer - periodically or once.
MonotonicDuration getPeriod () const
 Returns period if the timer is in periodic mode.

Detailed Description

Helper for broadcasting the message uavcan.protocol.Panic.

Definition at line 18 of file panic_broadcaster.hpp.


Member Function Documentation

void dontPanic (  )

Stop broadcasting immediately.

Definition at line 78 of file panic_broadcaster.hpp.

void panic ( const char *  short_reason_description,
MonotonicDuration  broadcasting_period = MonotonicDuration::fromMSec(100),
const TransferPriority  priority = TransferPriority::Default 
)

This method does not block and can't fail.

Parameters:
short_reasonShort ASCII string that describes the reason of the panic, 7 characters max. If the string exceeds 7 characters, it will be truncated.
broadcasting_periodBroadcasting period. Optional.
priorityTransfer priority. Optional.

Definition at line 50 of file panic_broadcaster.hpp.