Classes | Enumerations | Functions
diagnostic_aggregator Namespace Reference

Classes

class  Aggregator
 Aggregator processes /diagnostics, republishes on /diagnostics_agg. More...
 
class  Analyzer
 Base class of all Analyzers. Loaded by aggregator. More...
 
class  AnalyzerGroup
 Allows analyzers to be grouped together, or used as sub-analyzers. More...
 
struct  BondIDMatch
 
class  DiscardAnalyzer
 DiscardAnalyzer is does not report any values. It is a subclass of GenericAnalyzer. More...
 
class  GenericAnalyzer
 GenericAnalyzer is most basic diagnostic Analyzer. More...
 
class  GenericAnalyzerBase
 GenericAnalyzerBase is the base class for GenericAnalyzer and OtherAnalyzer. More...
 
class  IgnoreAnalyzer
 IgnoreAnalyzer ignores all analyzer parameters and does nothing. More...
 
class  OtherAnalyzer
 
class  StatusItem
 Helper class to hold, store DiagnosticStatus messages. More...
 

Enumerations

enum  DiagnosticLevel { Level_OK = diagnostic_msgs::DiagnosticStatus::OK, Level_Warn = diagnostic_msgs::DiagnosticStatus::WARN, Level_Error = diagnostic_msgs::DiagnosticStatus::ERROR, Level_Stale = 3 }
 Level of StatusItem. OK, Warn, Error, Stale. More...
 

Functions

std::string getOutputName (const std::string item_name)
 Replace "/" with "" in output name, to avoid confusing robot monitor. More...
 
bool getParamVals (XmlRpc::XmlRpcValue param, std::vector< std::string > &output)
 Returns list of strings from a parameter. More...
 
std::string removeLeadingNameChaff (const std::string &input_name, const std::string &chaff)
 Removes redundant prefixes from status name. More...
 
DiagnosticLevel valToLevel (const int val)
 Converts in to DiagnosticLevel. Values: [0, 3]. More...
 
std::string valToMsg (const int val)
 Converts int to message {0: 'OK', 1: 'Warning', 2: 'Error', 3: 'Stale' }. More...
 

Detailed Description

Author
Kevin Watts

!<

Author
Kevin Watts

Enumeration Type Documentation

◆ DiagnosticLevel

Level of StatusItem. OK, Warn, Error, Stale.

Enumerator
Level_OK 
Level_Warn 
Level_Error 
Level_Stale 

Definition at line 104 of file status_item.h.

Function Documentation

◆ getOutputName()

std::string diagnostic_aggregator::getOutputName ( const std::string  item_name)
inline

Replace "/" with "" in output name, to avoid confusing robot monitor.

Definition at line 87 of file status_item.h.

◆ getParamVals()

bool diagnostic_aggregator::getParamVals ( XmlRpc::XmlRpcValue  param,
std::vector< std::string > &  output 
)
inline

Returns list of strings from a parameter.

Given an XmlRpcValue, gives vector of strings of that parameter

Returns
False if XmlRpcValue is not string or array of strings

Definition at line 97 of file generic_analyzer.h.

◆ removeLeadingNameChaff()

std::string diagnostic_aggregator::removeLeadingNameChaff ( const std::string &  input_name,
const std::string &  chaff 
)
inline

Removes redundant prefixes from status name.

Useful for cleaning up status names. Ex: "/Hokuyo/Tilt HK/tilt_node: Connection" to "/Hokuyo/Tilt HK/Connection"

For multiple values of chaff, users will have to run this command for each value. This function won't work properly if multiple chaff values can be removed. For example, name "prosilica_camera: Frequency" with chaff ("prosilica", "prosilica_camera") will become "_camera: Frequency" if "prosilica" is removed first.

Definition at line 159 of file status_item.h.

◆ valToLevel()

DiagnosticLevel diagnostic_aggregator::valToLevel ( const int  val)
inline

Converts in to DiagnosticLevel. Values: [0, 3].

Definition at line 115 of file status_item.h.

◆ valToMsg()

std::string diagnostic_aggregator::valToMsg ( const int  val)
inline

Converts int to message {0: 'OK', 1: 'Warning', 2: 'Error', 3: 'Stale' }.

Definition at line 133 of file status_item.h.



diagnostic_aggregator
Author(s): Kevin Watts, Brice Rebsamen
autogenerated on Mon Aug 3 2020 03:19:16