.. _program_listing_file__tmp_ws_src_diagnostics_diagnostic_aggregator_include_diagnostic_aggregator_analyzer.hpp:

Program Listing for File analyzer.hpp
=====================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_diagnostics_diagnostic_aggregator_include_diagnostic_aggregator_analyzer.hpp>` (``/tmp/ws/src/diagnostics/diagnostic_aggregator/include/diagnostic_aggregator/analyzer.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   /*********************************************************************
    * Software License Agreement (BSD License)
    *
    *  Copyright (c) 2009, Willow Garage, Inc.
    *  All rights reserved.
    *
    *  Redistribution and use in source and binary forms, with or without
    *  modification, are permitted provided that the following conditions
    *  are met:
    *
    *   * Redistributions of source code must retain the above copyright
    *     notice, this list of conditions and the following disclaimer.
    *   * Redistributions in binary form must reproduce the above
    *     copyright notice, this list of conditions and the following
    *     disclaimer in the documentation and/or other materials provided
    *     with the distribution.
    *   * Neither the name of the Willow Garage nor the names of its
    *     contributors may be used to endorse or promote products derived
    *     from this software without specific prior written permission.
    *
    *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
    *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
    *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
    *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
    *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    *  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
    *  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    *  POSSIBILITY OF SUCH DAMAGE.
    *********************************************************************/
   
   #ifndef DIAGNOSTIC_AGGREGATOR__ANALYZER_HPP_
   #define DIAGNOSTIC_AGGREGATOR__ANALYZER_HPP_
   
   #include <map>
   #include <memory>
   #include <string>
   #include <vector>
   
   #include "diagnostic_aggregator/status_item.hpp"
   #include "diagnostic_aggregator/visibility_control.hpp"
   
   #include "diagnostic_msgs/msg/diagnostic_status.h"
   #include "diagnostic_msgs/msg/key_value.h"
   
   #include "rclcpp/rclcpp.hpp"
   
   namespace diagnostic_aggregator
   {
   class Analyzer
   {
   public:
     Analyzer()
     : clock_(std::make_shared<rclcpp::Clock>()) {}
   
     virtual ~Analyzer() {}
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual bool init(
       const std::string & base_path, const std::string & breadcrumb,
       const rclcpp::Node::SharedPtr node) = 0;
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual bool match(const std::string & name) = 0;
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual bool analyze(const std::shared_ptr<StatusItem> item) = 0;
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual std::vector<std::shared_ptr<diagnostic_msgs::msg::DiagnosticStatus>> report() = 0;
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual std::string getPath() const = 0;
   
     DIAGNOSTIC_AGGREGATOR_PUBLIC
     virtual std::string getName() const = 0;
   
   protected:
     rclcpp::Clock::SharedPtr clock_;
   };
   
   }  // namespace diagnostic_aggregator
   
   #endif  // DIAGNOSTIC_AGGREGATOR__ANALYZER_HPP_