TopicStatistics.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2020 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 IGN_TRANSPORT_TOPICSTATISTICS_HH_
#define IGN_TRANSPORT_TOPICSTATISTICS_HH_

#include <ignition/msgs/statistic.pb.h>

#include <limits>
#include <memory>
#include <string>
#include "ignition/transport/config.hh"
#include "ignition/transport/Export.hh"

namespace ignition
{
  namespace transport
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_TRANSPORT_VERSION_NAMESPACE {
    //
    // Forward declarations.
    class TopicStatisticsPrivate;

    class IGNITION_TRANSPORT_VISIBLE Statistics
    {
      public: Statistics() = default;

      public: ~Statistics() = default;

      public: void Update(double _stat);

      public: double Avg() const;

      public: double StdDev() const;

      public: double Min() const;

      public: double Max() const;

      public: uint64_t Count() const;

      private: uint64_t count = 0;

      private: double average = 0;

      private: double sumSquareMeanDist = 0;

      private: double min = std::numeric_limits<double>::max();

      private: double max = std::numeric_limits<double>::min();
    };

    class IGNITION_TRANSPORT_VISIBLE TopicStatistics
    {
      public: TopicStatistics();

      public: TopicStatistics(const TopicStatistics &_stats);

      public: ~TopicStatistics();

      public: void Update(const std::string &_sender,
                          uint64_t _stamp, uint64_t _seq);

      public: void FillMessage(msgs::Metric &_msg) const;

      public: uint64_t DroppedMsgCount() const;

      public: Statistics PublicationStatistics() const;

      public: Statistics ReceptionStatistics() const;

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