psen_scan_v2_standalone::protocol_layer Namespace Reference

Namespace for the implementation of the scanner protocol state machine. More...

Namespaces
	scanner_events
	Contains the events needed to define and implement the scanner protocol.

Classes
class	IWatchdogFactory
	Interface to create event timeout callbacks. More...
class	OutdatedMessageError
	Exception thrown if the incoming frame has an outdated scan_counter. More...
class	ScanBuffer
	Buffers and validates monitoring frames for a scan round. More...
class	ScannerProtocolDef
	Definition of the scanner protocol. It is initialized using the StateMachineArgs class. More...
class	ScanRoundEndedEarlyError
	Exception thrown if a new scan round started without the last one finishing. More...
class	ScanRoundError
	Exception indicating problems with the monitoring frames of a scan round. More...
class	ScanRoundOversaturatedError
	Exception thrown if a scan round has to many messages. More...
class	WatchdogFactory
	Watchdog factory implementation for scanner interaction timeouts. More...

Typedefs
using	ErrorCallback = std::function< void(const std::string &)>
using	InformUserAboutLaserScanCallback = std::function< void(const LaserScan &)>
using	LaserScanCallback = std::function< void(const LaserScan &)>
using	MonitoringFrameCallback = std::function< void(const data_conversion_layer::monitoring_frame::Message &)>
using	ReplyCallback = std::function< void()>
using	ScannerStartedCallback = std::function< void()>
using	ScannerStateMachine = msm::back::state_machine< ScannerProtocolDef >
	State machine handling all events according to the scanner protocol and error handling specification. More...
using	ScannerStoppedCallback = std::function< void()>
using	SendRequestCallback = std::function< void()>
using	StartErrorCallback = std::function< void(const std::string &)>
using	StopErrorCallback = std::function< void(const std::string &)>
using	TimeoutCallback = std::function< void()>

Functions
template<class T >
static std::string	classNameShort (const T &t)
template<class FSM >
static std::string	getStateName (const int &state_id)

Variables
static constexpr uint32_t	DEFAULT_NUM_MSG_PER_ROUND { 6 }
static constexpr std::chrono::milliseconds	WATCHDOG_TIMEOUT { 1000 }

Detailed Description

Namespace for the implementation of the scanner protocol state machine.

Contains all things needed to describe and implement the scanner protocol.

Typedef Documentation

ErrorCallback

using psen_scan_v2_standalone::protocol_layer::ErrorCallback = typedef std::function<void(const std::string&)>

Definition at line 31 of file function_pointers.h.

InformUserAboutLaserScanCallback

using psen_scan_v2_standalone::protocol_layer::InformUserAboutLaserScanCallback = typedef std::function<void(const LaserScan&)>

Definition at line 92 of file scanner_state_machine.h.

LaserScanCallback

using psen_scan_v2_standalone::protocol_layer::LaserScanCallback = typedef std::function<void(const LaserScan&)>

Definition at line 32 of file function_pointers.h.

MonitoringFrameCallback

using psen_scan_v2_standalone::protocol_layer::MonitoringFrameCallback = typedef std::function<void(const data_conversion_layer::monitoring_frame::Message&)>

Definition at line 30 of file function_pointers.h.

ReplyCallback

using psen_scan_v2_standalone::protocol_layer::ReplyCallback = typedef std::function<void()>

Definition at line 29 of file function_pointers.h.

ScannerStartedCallback

using psen_scan_v2_standalone::protocol_layer::ScannerStartedCallback = typedef std::function<void()>

Definition at line 87 of file scanner_state_machine.h.

ScannerStateMachine

using psen_scan_v2_standalone::protocol_layer::ScannerStateMachine = typedef msm::back::state_machine<ScannerProtocolDef>

State machine handling all events according to the scanner protocol and error handling specification.

See also

protocol_layer::ScannerProtocolDef

Definition at line 317 of file scanner_state_machine.h.

ScannerStoppedCallback

using psen_scan_v2_standalone::protocol_layer::ScannerStoppedCallback = typedef std::function<void()>

Definition at line 88 of file scanner_state_machine.h.

SendRequestCallback

using psen_scan_v2_standalone::protocol_layer::SendRequestCallback = typedef std::function<void()>

Definition at line 28 of file function_pointers.h.

StartErrorCallback

using psen_scan_v2_standalone::protocol_layer::StartErrorCallback = typedef std::function<void(const std::string&)>

Definition at line 89 of file scanner_state_machine.h.

StopErrorCallback

using psen_scan_v2_standalone::protocol_layer::StopErrorCallback = typedef std::function<void(const std::string&)>

Definition at line 90 of file scanner_state_machine.h.

TimeoutCallback

using psen_scan_v2_standalone::protocol_layer::TimeoutCallback = typedef std::function<void()>

Definition at line 91 of file scanner_state_machine.h.

Function Documentation

classNameShort()

template<class T >

static std::string psen_scan_v2_standalone::protocol_layer::classNameShort ( const T &  t )

static

Definition at line 430 of file scanner_state_machine_def.h.

getStateName()

template<class FSM >

static std::string psen_scan_v2_standalone::protocol_layer::getStateName ( const int &  state_id )

static

Definition at line 417 of file scanner_state_machine_def.h.

Variable Documentation

DEFAULT_NUM_MSG_PER_ROUND

constexpr uint32_t psen_scan_v2_standalone::protocol_layer::DEFAULT_NUM_MSG_PER_ROUND { 6 }

staticconstexpr

Definition at line 85 of file scanner_state_machine.h.

WATCHDOG_TIMEOUT

constexpr std::chrono::milliseconds psen_scan_v2_standalone::protocol_layer::WATCHDOG_TIMEOUT { 1000 }

staticconstexpr

Definition at line 84 of file scanner_state_machine.h.