File: SignalStatsPrivate.hh

package info (click to toggle)
ignition-math2 2.9.0%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,812 kB
  • sloc: cpp: 15,329; python: 2,716; ansic: 339; sh: 185; makefile: 11
file content (74 lines) | stat: -rw-r--r-- 2,208 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
 * 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_SIGNAL_STATS_PRIVATE_HH_
#define IGNITION_MATH_SIGNAL_STATS_PRIVATE_HH_

#include <memory>
#include <vector>

namespace ignition
{
  namespace math
  {
    /// \brief Private data class for the SignalStatistic class.
    class SignalStatisticPrivate
    {
      /// \brief Scalar representation of signal data.
      public: double data;

      /// \brief Scalar representation of extra signal data.
      /// For example, the standard deviation statistic needs an extra variable.
      public: double extraData;

      /// \brief Count of data values in mean.
      public: unsigned int count;

      /// \brief Clone the SignalStatisticPrivate object. Used for implementing
      /// copy semantics.
      public: SignalStatisticPrivate *Clone() const
      {
        return new SignalStatisticPrivate(*this);
      }
    };

    class SignalStatistic;

    /// \def SignalStatisticPtr
    /// \brief Shared pointer to SignalStatistic object
    typedef std::shared_ptr<SignalStatistic> SignalStatisticPtr;

    /// \def SignalStatistic_V
    /// \brief Vector of SignalStatisticPtr
    typedef std::vector<SignalStatisticPtr> SignalStatistic_V;

    /// \brief Private data class for the SignalStats class.
    class SignalStatsPrivate
    {
      /// \brief Vector of `SignalStatistic`s.
      public: SignalStatistic_V stats;

      /// \brief Clone the SignalStatsPrivate object. Used for implementing
      /// copy semantics.
      public: SignalStatsPrivate *Clone() const
      {
        return new SignalStatsPrivate(*this);
      }
    };
  }
}
#endif