diagnostic_aggregator::IgnoreAnalyzer Class Reference

IgnoreAnalyzer ignores all analyzer parameters and does nothing. More...

#include <ignore_analyzer.h>

Inheritance diagram for diagnostic_aggregator::IgnoreAnalyzer:

Public Member Functions
bool	analyze (boost::shared_ptr< StatusItem > item)
	Returns true if analyzer will analyze this name. More...
std::string	getName () const
	Returns nice name for display. (ex: 'Sensors') More...
std::string	getPath () const
	Returns full prefix of analyzer. (ex: '/Robot/Sensors') More...
	IgnoreAnalyzer ()
	Default constructor loaded by pluginlib. More...
bool	init (const std::string base_name, const ros::NodeHandle &n)
	Analyzer is initialized with base path and namespace. More...
bool	match (const std::string name)
	Returns true if analyzer will handle this item. More...
virtual std::vector< boost::shared_ptr< diagnostic_msgs::DiagnosticStatus > >	report ()
	Analysis function, output processed data. More...
virtual	~IgnoreAnalyzer ()
Public Member Functions inherited from diagnostic_aggregator::Analyzer
	Analyzer ()
	Default constructor, called by pluginlib. More...
virtual	~Analyzer ()

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

IgnoreAnalyzer()

diagnostic_aggregator::IgnoreAnalyzer::IgnoreAnalyzer

(

)

Default constructor loaded by pluginlib.

~IgnoreAnalyzer()

IgnoreAnalyzer::~IgnoreAnalyzer ( )

virtual

Definition at line 49 of file ignore_analyzer.cpp.

Member Function Documentation

analyze()

bool diagnostic_aggregator::IgnoreAnalyzer::analyze ( boost::shared_ptr< StatusItem >  item )

inlinevirtual

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.

getName()

std::string diagnostic_aggregator::IgnoreAnalyzer::getName ( ) const

inlinevirtual

Returns nice name for display. (ex: 'Sensors')

Implements diagnostic_aggregator::Analyzer.

Definition at line 89 of file ignore_analyzer.h.

getPath()

std::string diagnostic_aggregator::IgnoreAnalyzer::getPath ( ) const

inlinevirtual

Returns full prefix of analyzer. (ex: '/Robot/Sensors')

Implements diagnostic_aggregator::Analyzer.

Definition at line 88 of file ignore_analyzer.h.

init()

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.

match()

bool diagnostic_aggregator::IgnoreAnalyzer::match ( const std::string  name )

inlinevirtual

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.

report()

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:

• ignore_analyzer.h
• ignore_analyzer.cpp