EMANE  1.2.1
statisticregistrar.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014,2016 - Adjacent Link LLC, Bridgewater, New
3  * Jersey
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of Adjacent Link LLC nor the names of its
17  * contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef EMANESTATISTICREGISTRAR_HEADER_
35 #define EMANESTATISTICREGISTRAR_HEADER_
36 
37 #include "emane/statistic.h"
38 #include "emane/statisticnumeric.h"
40 #include "emane/statistictable.h"
42 
43 #include <string>
44 #include <functional>
45 
46 namespace EMANE
47 {
60  {
61  public:
65  virtual ~StatisticRegistrar(){}
66 
81  template<typename T>
82  StatisticNumeric<T> * registerNumeric(const std::string & sName,
84  const std::string & sDescription = "");
85 
101  template<typename T>
102  StatisticNonNumeric<T> * registerNonNumeric(const std::string & sName,
103  const StatisticProperties & properties = StatisticProperties::NONE,
104  const std::string & sDescription = "");
105 
106 
129  template<typename Key,
130  typename Compare = std::less<EMANE::Any>,
131  std::size_t scolumn = 0>
133  registerTable(const std::string & sName,
134  const StatisticTableLabels & labels,
135  const StatisticProperties & properties = StatisticProperties::NONE,
136  const std::string & sDescription = "");
137 
138 
167  template<typename Key,
168  typename Function,
169  typename Compare = std::less<EMANE::Any>,
170  std::size_t scolumn = 0>
172  registerTable(const std::string & sName,
173  const StatisticTableLabels & labels,
174  Function clearFunc,
175  const std::string & sDescription = "");
176 
177 
178  protected:
191  virtual void registerStatistic(const std::string & sName,
192  Any::Type type,
193  const StatisticProperties & properties,
194  const std::string & sDescription,
195  Statistic * pStatistic) = 0;
196 
210  virtual void registerTablePublisher(const std::string & sName,
211  const StatisticProperties & properties,
212  const std::string & sDescription,
213  StatisticTablePublisher * pStatiticTablePublisher,
214  std::function<void(StatisticTablePublisher * p)> clearFunc) = 0;
215  };
216 }
217 
219 
220 #endif // EMANESTATISTICREGISTRAR_HEADER_
221 
A two dimentional statistic table that holds Any values.
A non-numeric statistic can be a std::string or an INETAddr.
A StatisticTablePublisher produces two dimensional tables of Anys.
Type
Definition: any.h:52
virtual void registerTablePublisher(const std::string &sName, const StatisticProperties &properties, const std::string &sDescription, StatisticTablePublisher *pStatiticTablePublisher, std::function< void(StatisticTablePublisher *p)> clearFunc)=0
The StatisticRegistrar allows NEM layers to register statistics and statistic tables. Statistics and Statistic tables are owned by the emulator framework and a borrowed reference is returned to the registering NEM layer.
std::vector< std::string > StatisticTableLabels
StatisticTable< Key, Compare, scolumn > * registerTable(const std::string &sName, const StatisticTableLabels &labels, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")
StatisticNumeric< T > * registerNumeric(const std::string &sName, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")
The Statistic interface is the base class of all statistics. It provided methods to access and clear ...
Definition: statistic.h:48
StatisticNonNumeric< T > * registerNonNumeric(const std::string &sName, const StatisticProperties &properties=StatisticProperties::NONE, const std::string &sDescription="")
virtual void registerStatistic(const std::string &sName, Any::Type type, const StatisticProperties &properties, const std::string &sDescription, Statistic *pStatistic)=0
Definition: agent.h:43
Defines a numeric statistic and its operations.