SignalStats.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2014-2016 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 _GAZEBO_SIGNAL_STATS_HH_
#define _GAZEBO_SIGNAL_STATS_HH_

#include <map>
#include <string>
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace math
  {

    class SignalStatisticPrivate;

    class GZ_MATH_VISIBLE SignalStatistic
    {
      public: SignalStatistic();

      public: virtual ~SignalStatistic();

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

      protected: SignalStatisticPrivate *dataPtr;
    };

    class GZ_MATH_VISIBLE SignalMean : public SignalStatistic
    {
      // Documentation inherited.
      public: virtual double Value() const;

      public: virtual std::string ShortName() const;

      // Documentation inherited.
      public: virtual void InsertData(const double _data);
    };

    class GZ_MATH_VISIBLE SignalRootMeanSquare : public SignalStatistic
    {
      // Documentation inherited.
      public: virtual double Value() const;

      public: virtual std::string ShortName() const;

      // Documentation inherited.
      public: virtual void InsertData(const double _data);
    };

    class GZ_MATH_VISIBLE SignalMaxAbsoluteValue : public SignalStatistic
    {
      // Documentation inherited.
      public: virtual double Value() const;

      public: virtual std::string ShortName() const;

      // Documentation inherited.
      public: virtual void InsertData(const double _data);
    };

    class SignalStatsPrivate;

    class GZ_MATH_VISIBLE SignalStats
    {
      public: 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();

      protected: SignalStatsPrivate *dataPtr;
    };
  }
}
#endif