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 IGNITION_MATH_SIGNALSTATS_HH_
#define IGNITION_MATH_SIGNALSTATS_HH_

#include <map>
#include <memory>
#include <string>
#include <ignition/math/Helpers.hh>
#include <ignition/math/config.hh>

namespace ignition
{
  namespace math
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_MATH_VERSION_NAMESPACE {
    //
    class SignalStatisticPrivate;

    class IGNITION_MATH_VISIBLE SignalStatistic
    {
      public: SignalStatistic();

      public: virtual ~SignalStatistic();

      public: SignalStatistic(const SignalStatistic &_ss);

      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();

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      protected: std::unique_ptr<SignalStatisticPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };

    class IGNITION_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 IGNITION_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 IGNITION_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 IGNITION_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 IGNITION_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 IGNITION_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 SignalStatsPrivate;

    class IGNITION_MATH_VISIBLE SignalStats
    {
      public: SignalStats();

      public: ~SignalStats();

      public: SignalStats(const SignalStats &_ss);

      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();

      public: SignalStats &operator=(const SignalStats &_s);

#ifdef _WIN32
// Disable warning C4251 which is triggered by
// std::unique_ptr
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
      private: std::unique_ptr<SignalStatsPrivate> dataPtr;
#ifdef _WIN32
#pragma warning(pop)
#endif
    };
    }
  }
}
#endif