uavcan::PanicBroadcaster Class Reference

#include <panic_broadcaster.hpp>

Inheritance diagram for uavcan::PanicBroadcaster:

Public Member Functions
void	dontPanic ()
const protocol::Panic::FieldTypes::reason_text &	getReason () const
bool	isPanicking () const
void	panic (const char *short_reason_description, MonotonicDuration broadcasting_period=MonotonicDuration::fromMSec(100), const TransferPriority priority=TransferPriority::Default)
	PanicBroadcaster (INode &node)

Private Member Functions
virtual void	handleTimerEvent (const TimerEvent &)
void	publishOnce ()
Private Member Functions inherited from uavcan::TimerBase
MonotonicDuration	getPeriod () const
void	startOneShotWithDeadline (MonotonicTime deadline)
void	startOneShotWithDelay (MonotonicDuration delay)
void	startPeriodic (MonotonicDuration period)
	TimerBase (INode &node)

Private Attributes
protocol::Panic	msg_
Publisher< protocol::Panic >	pub_

Detailed Description

Helper for broadcasting the message uavcan.protocol.Panic.

Definition at line 18 of file panic_broadcaster.hpp.

Constructor & Destructor Documentation

PanicBroadcaster()

uavcan::PanicBroadcaster::PanicBroadcaster ( INode &  node )

inlineexplicit

Definition at line 38 of file panic_broadcaster.hpp.

Member Function Documentation

dontPanic()

void uavcan::PanicBroadcaster::dontPanic ( )

inline

Stop broadcasting immediately.

Definition at line 78 of file panic_broadcaster.hpp.

getReason()

const protocol::Panic::FieldTypes::reason_text& uavcan::PanicBroadcaster::getReason ( ) const

inline

Definition at line 86 of file panic_broadcaster.hpp.

handleTimerEvent()

virtual void uavcan::PanicBroadcaster::handleTimerEvent ( const TimerEvent &  event )

inlineprivatevirtual

Implement this method in your class to receive callbacks.

Implements uavcan::TimerBase.

Definition at line 32 of file panic_broadcaster.hpp.

isPanicking()

bool uavcan::PanicBroadcaster::isPanicking ( ) const

inline

Definition at line 84 of file panic_broadcaster.hpp.

panic()

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

inline

This method does not block and can't fail.

Parameters

short_reason	Short ASCII string that describes the reason of the panic, 7 characters max. If the string exceeds 7 characters, it will be truncated.
broadcasting_period	Broadcasting period. Optional.
priority	Transfer priority. Optional.

Definition at line 50 of file panic_broadcaster.hpp.

publishOnce()

void uavcan::PanicBroadcaster::publishOnce ( )

inlineprivate

Definition at line 23 of file panic_broadcaster.hpp.

Member Data Documentation

msg_

protocol::Panic uavcan::PanicBroadcaster::msg_

private

Definition at line 21 of file panic_broadcaster.hpp.

pub_

Publisher<protocol::Panic> uavcan::PanicBroadcaster::pub_

private

Definition at line 20 of file panic_broadcaster.hpp.

---

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

• panic_broadcaster.hpp