SignalStats.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef GZ_MATH_SIGNALSTATS_HH_
#define GZ_MATH_SIGNALSTATS_HH_
 
#include <map>
#include <memory>
#include <string>
#include <gz/math/Helpers.hh>
#include <gz/math/config.hh>
#include <gz/utils/ImplPtr.hh>
 
namespace gz::math
{
  // Inline bracket to help doxygen filtering.
  inline namespace GZ_MATH_VERSION_NAMESPACE {
  //
  class SignalStatisticPrivate;
 
  class GZ_MATH_VISIBLE SignalStatistic
  {
    public: SignalStatistic();
 
    public: virtual ~SignalStatistic() = default;
 
    // Since we have to declare the destructor virtual, we have to declare the
    // all the special member functions as defaulted.
    // See https://en.cppreference.com/w/cpp/language/rule_of_three
 
    public: SignalStatistic(const SignalStatistic &_ss) = default;
 
    public: SignalStatistic(SignalStatistic &&_ss) = default;
 
    public: SignalStatistic &operator=(const SignalStatistic &_s) = default;
 
    public: SignalStatistic &operator=(SignalStatistic &&_s) = default;
 
    public: virtual double Value() const = 0;
 
    public: virtual std::string ShortName() const = 0;
 
    public: virtual size_t Count() const;
 
    public: virtual void InsertData(const double _data) = 0;
 
    public: virtual void Reset();
 
    public: class Implementation;
    GZ_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
    protected: ::gz::utils::ImplPtr<Implementation> dataPtr;
    GZ_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
  };
 
  class GZ_MATH_VISIBLE SignalMaximum : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalMean : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalMinimum : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalRootMeanSquare : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalMaxAbsoluteValue : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalVariance : public SignalStatistic
  {
    // Documentation inherited.
    public: virtual double Value() const override;
 
    public: virtual std::string ShortName() const override;
 
    // Documentation inherited.
    public: virtual void InsertData(const double _data) override;
  };
 
  class GZ_MATH_VISIBLE SignalStats
  {
    public: SignalStats();
 
    public: size_t Count() const;
 
    public: std::map<std::string, double> Map() const;
 
    public: void InsertData(const double _data);
 
    public: bool InsertStatistic(const std::string &_name);
 
    public: bool InsertStatistics(const std::string &_names);
 
    public: void Reset();
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }  // namespace GZ_MATH_VERSION_NAMESPACE
}  // namespace gz::math
#endif  // GZ_MATH_SIGNALSTATS_HH_