satellite-stats-rbdc-request-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2018 CNES
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathias Ettinger <mettinger@toulouse.viveris.com>
19  */
20 
21 #ifndef SATELLITE_STATS_RBDC_REQUEST_HELPER_H
22 #define SATELLITE_STATS_RBDC_REQUEST_HELPER_H
23 
24 #include <ns3/address.h>
25 #include <ns3/collector-map.h>
26 #include <ns3/ptr.h>
27 #include <ns3/satellite-stats-helper.h>
28 
29 #include <list>
30 #include <map>
31 
32 namespace ns3
33 {
34 
35 class SatHelper;
36 class Node;
37 class Time;
38 class DataCollectionObject;
39 class DistributionCollector;
40 
46 {
47  public:
48  // inherited from SatStatsHelper base class
49  SatStatsRbdcRequestHelper(Ptr<const SatHelper> satHelper);
50 
55 
59  static TypeId GetTypeId();
60 
64  void SetAveragingMode(bool averagingMode);
65 
69  bool GetAveragingMode() const;
70 
75  void InstallProbes();
76 
82  void RbdcRateCallback(std::string identifier, uint32_t rbdcTraceKbps);
83 
84  protected:
85  // inherited from SatStatsHelper base class
86  void DoInstall();
87 
89  CollectorMap m_terminalCollectors;
90 
92  Ptr<DistributionCollector> m_averagingCollector;
93 
95  Ptr<DataCollectionObject> m_aggregator;
96 
97  private:
99 
100 }; // end of class SatStatsRbdcRequestHelper
101 
102 } // namespace ns3
103 
104 #endif /* SATELLITE_STATS_RBDC_REQUEST_HELPER_H */
Parent abstract class of all satellite statistics helpers.
Base class for RBDC requests statistics helpers.
void DoInstall()
Install the probes, collectors, and aggregators necessary to produce the statistics output.
static TypeId GetTypeId()
inherited from ObjectBase base class
Ptr< DataCollectionObject > m_aggregator
The aggregator created by this helper.
void InstallProbes()
Set up several probes or other means of listeners and connect them to the collectors.
SatStatsRbdcRequestHelper(Ptr< const SatHelper > satHelper)
void RbdcRateCallback(std::string identifier, uint32_t rbdcTraceKbps)
Receive inputs from trace sources.
CollectorMap m_terminalCollectors
Maintains a list of collectors created by this helper.
Ptr< DistributionCollector > m_averagingCollector
The final collector utilized in averaged output (histogram, PDF, and CDF).
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.