analyzer.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2009, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the Willow Garage nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
39 #ifndef DIAGNOSTIC_ANALYZER_H
40 #define DIAGNOSTIC_ANALYZER_H
41 
42 #include <map>
43 #include <vector>
44 #include <ros/ros.h>
45 #include <diagnostic_msgs/DiagnosticStatus.h>
46 #include <diagnostic_msgs/KeyValue.h>
48 
49 namespace diagnostic_aggregator {
50 
85 class Analyzer
86 {
87 public:
91  Analyzer() {}
92 
93  virtual ~Analyzer() {}
94 
104  virtual bool init(const std::string base_path, const ros::NodeHandle &n) = 0;
105 
112  virtual bool match(const std::string name) = 0;
113 
121  virtual bool analyze(const boost::shared_ptr<StatusItem> item) = 0;
122 
131  virtual std::vector<boost::shared_ptr<diagnostic_msgs::DiagnosticStatus> > report() = 0;
132 
136  virtual std::string getPath() const = 0;
137 
141  virtual std::string getName() const = 0;
142 
143 };
144 
145 }
146 
147 #endif //DIAGNOSTIC_ANALYZER_H
diagnostic_aggregator
Definition: aggregator.h:61
boost::shared_ptr
ros.h
status_item.h
testing::internal::string
::std::string string
Definition: gtest.h:1979
diagnostic_aggregator::Analyzer::report
virtual std::vector< boost::shared_ptr< diagnostic_msgs::DiagnosticStatus > > report()=0
Analysis function, output processed data.
diagnostic_aggregator::Analyzer::init
virtual bool init(const std::string base_path, const ros::NodeHandle &n)=0
Analyzer is initialized with base path and namespace.
diagnostic_aggregator::Analyzer::Analyzer
Analyzer()
Default constructor, called by pluginlib.
Definition: analyzer.h:155
diagnostic_aggregator::Analyzer::~Analyzer
virtual ~Analyzer()
Definition: analyzer.h:157
diagnostic_aggregator::Analyzer::getPath
virtual std::string getPath() const =0
Returns full prefix of analyzer. (ex: '/Robot/Sensors')
diagnostic_aggregator::Analyzer::getName
virtual std::string getName() const =0
Returns nice name for display. (ex: 'Sensors')
diagnostic_aggregator::Analyzer::match
virtual bool match(const std::string name)=0
Returns true if analyzer will handle this item.
ros::NodeHandle
diagnostic_aggregator::Analyzer::analyze
virtual bool analyze(const boost::shared_ptr< StatusItem > item)=0
Returns true if analyzer will analyze this name.


diagnostic_aggregator
Author(s): Kevin Watts, Brice Rebsamen
autogenerated on Wed Aug 3 2022 02:15:35