IgnoreAnalyzer ignores all analyzer parameters and does nothing. More...
#include <ignore_analyzer.h>
Public Member Functions | |
| bool | analyze (boost::shared_ptr< StatusItem > item) |
| Returns true if analyzer will analyze this name. | |
| std::string | getName () const |
| Returns nice name for display. (ex: 'Sensors') | |
| std::string | getPath () const |
| Returns full prefix of analyzer. (ex: '/Robot/Sensors') | |
| IgnoreAnalyzer () | |
| Default constructor loaded by pluginlib. | |
| bool | init (const std::string base_name, const ros::NodeHandle &n) |
| Analyzer is initialized with base path and namespace. | |
| bool | match (const std::string name) |
| Returns true if analyzer will handle this item. | |
| virtual std::vector < boost::shared_ptr < diagnostic_msgs::DiagnosticStatus > > | report () |
| Analysis function, output processed data. | |
| virtual | ~IgnoreAnalyzer () |
Detailed Description
IgnoreAnalyzer ignores all analyzer parameters and does nothing.
IgnoreAnalyzer is used to get rid of an Analyzer that is no longer part of a robot configuration.
*<launch> * <include file="$(find my_pkg)/my_analyzers.launch" /> * * <!-- Overwrite a specific Analyzer to discard all --> * <param name="diag_agg/analyzers/motors/type" value="IgnoreAnalyzer" /> *</launch> *
Definition at line 67 of file ignore_analyzer.h.
Constructor & Destructor Documentation
Default constructor loaded by pluginlib.
| IgnoreAnalyzer::~IgnoreAnalyzer | ( | ) | [virtual] |
Definition at line 49 of file ignore_analyzer.cpp.
Member Function Documentation
| bool diagnostic_aggregator::IgnoreAnalyzer::analyze | ( | boost::shared_ptr< StatusItem > | item | ) | [inline, virtual] |
Returns true if analyzer will analyze this name.
This is called with every new item that an analyzer matches. Analyzers should only return "true" if they will report the value of this item. If it is only looking at an item, it should return false.
Implements diagnostic_aggregator::Analyzer.
Definition at line 81 of file ignore_analyzer.h.
| std::string diagnostic_aggregator::IgnoreAnalyzer::getName | ( | ) | const [inline, virtual] |
Returns nice name for display. (ex: 'Sensors')
Implements diagnostic_aggregator::Analyzer.
Definition at line 89 of file ignore_analyzer.h.
| std::string diagnostic_aggregator::IgnoreAnalyzer::getPath | ( | ) | const [inline, virtual] |
Returns full prefix of analyzer. (ex: '/Robot/Sensors')
Implements diagnostic_aggregator::Analyzer.
Definition at line 88 of file ignore_analyzer.h.
| bool IgnoreAnalyzer::init | ( | const std::string | base_path, |
| const ros::NodeHandle & | n | ||
| ) | [virtual] |
Analyzer is initialized with base path and namespace.
The Analyzer initialized with parameters in its given namespace. The "base_path" is common to all analyzers, and needs to be prepended to all DiagnosticStatus names.
- Parameters:
-
base_path : Common to all analyzers, prepended to all processed names. Starts with "/". n : NodeHandle with proper private namespace for analyzer.
Implements diagnostic_aggregator::Analyzer.
Definition at line 51 of file ignore_analyzer.cpp.
| bool diagnostic_aggregator::IgnoreAnalyzer::match | ( | const std::string | name | ) | [inline, virtual] |
Returns true if analyzer will handle this item.
Match is called once for each new status name, so this return value cannot change with time.
Implements diagnostic_aggregator::Analyzer.
Definition at line 79 of file ignore_analyzer.h.
| vector< boost::shared_ptr< diagnostic_msgs::DiagnosticStatus > > IgnoreAnalyzer::report | ( | ) | [virtual] |
Analysis function, output processed data.
report is called at 1Hz intervals. Analyzers should return a vector of processed DiagnosticStatus messages.
- Returns:
- The array of DiagnosticStatus messages must have proper names, with prefixes prepended
Implements diagnostic_aggregator::Analyzer.
Definition at line 56 of file ignore_analyzer.cpp.
The documentation for this class was generated from the following files: