cras::FilterChainDiagnostics< F > Class Template Reference

Diagnostics of performance of a filter chain. More...

#include <filter_chain_nodelet.hpp>

Public Member Functions
void	addReport (const ::std::string &filterName, bool success)
	Call this function every time a filter finished callback is called. More...
	FilterChainDiagnostics (const ::std::string &name, const ::cras::FilterChain< F > &chain)
void	run (::diagnostic_updater::DiagnosticStatusWrapper &stat) override

Protected Attributes
const ::cras::FilterChain< F > &	chain
	The diagnosed chain. More...
::std::mutex	mutex
	Mutex protecting numCallbacks, numSuccesses and numFailures. More...
::std::unordered_map<::std::string, size_t >	numCallbacks
	The overall number of callbacks since last update. More...
::std::unordered_map<::std::string, size_t >	numFailures
	The number of failed filter runs since last update. More...
::std::unordered_map<::std::string, size_t >	numSuccesses
	The number of successful filter runs since last update. More...

Detailed Description

template<typename F>
class cras::FilterChainDiagnostics< F >

Diagnostics of performance of a filter chain.

Template Parameters

F	Type of filtered data.

Definition at line 44 of file filter_utils/filter_chain_nodelet.hpp.

Constructor & Destructor Documentation

FilterChainDiagnostics()

template<typename F >

cras::FilterChainDiagnostics< F >::FilterChainDiagnostics	(	const ::std::string &	name,
		const ::cras::FilterChain< F > &	chain
	)

Parameters

[in]	name	Name of the diagnostic task.
[in]	chain	The diagnosed chain.

Member Function Documentation

addReport()

template<typename F >

void cras::FilterChainDiagnostics< F >::addReport	(	const ::std::string &	filterName,
		bool	success
	)

Call this function every time a filter finished callback is called.

Parameters

[in]	filterName	Name of the filter.
[in]	success	Whether the filter has succeeded.

run()

template<typename F >

void cras::FilterChainDiagnostics< F >::run ( ::diagnostic_updater::DiagnosticStatusWrapper &  stat )

override

Member Data Documentation

chain

template<typename F >

const ::cras::FilterChain<F>& cras::FilterChainDiagnostics< F >::chain

protected

The diagnosed chain.

Definition at line 342 of file filter_utils/filter_chain_nodelet.hpp.

mutex

template<typename F >

::std::mutex cras::FilterChainDiagnostics< F >::mutex

protected

Mutex protecting numCallbacks, numSuccesses and numFailures.

Definition at line 345 of file filter_utils/filter_chain_nodelet.hpp.

numCallbacks

template<typename F >

::std::unordered_map<::std::string, size_t> cras::FilterChainDiagnostics< F >::numCallbacks

protected

The overall number of callbacks since last update.

Definition at line 348 of file filter_utils/filter_chain_nodelet.hpp.

numFailures

template<typename F >

::std::unordered_map<::std::string, size_t> cras::FilterChainDiagnostics< F >::numFailures

protected

The number of failed filter runs since last update.

Definition at line 354 of file filter_utils/filter_chain_nodelet.hpp.

numSuccesses

template<typename F >

::std::unordered_map<::std::string, size_t> cras::FilterChainDiagnostics< F >::numSuccesses

protected

The number of successful filter runs since last update.

Definition at line 351 of file filter_utils/filter_chain_nodelet.hpp.

---

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

• filter_utils/filter_chain_nodelet.hpp