satellite-stats-fwd-link-scheduler-symbol-rate-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2019 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: Bastien Tauran <bastien.tauran@viveris.fr>
19  *
20  */
21 
22 #ifndef SATELLITE_STATS_FWD_LINK_SCHEDULER_SYMBOL_RATE_HELPER_H
23 #define SATELLITE_STATS_FWD_LINK_SCHEDULER_SYMBOL_RATE_HELPER_H
24 
25 #include "satellite-stats-helper.h"
26 
27 #include <ns3/callback.h>
28 #include <ns3/collector-map.h>
29 #include <ns3/ptr.h>
30 #include <ns3/satellite-enums.h>
31 
32 namespace ns3
33 {
34 
35 // BASE CLASS /////////////////////////////////////////////////////////////////
36 
37 class SatHelper;
38 class Node;
39 class Time;
40 class DataCollectionObject;
41 
47 {
48  public:
49  // inherited from SatStatsHelper base class
50  SatStatsFwdLinkSchedulerSymbolRateHelper(Ptr<const SatHelper> satHelper);
51 
56 
60  static TypeId GetTypeId();
61 
66  void InstallProbes();
67 
73  void SymbolRateCallback(uint8_t sliceId, double symbolRate);
74 
78  Callback<void, uint8_t, double> GetTraceSinkCallback() const;
79 
80  protected:
81  // inherited from SatStatsHelper base class
82  void DoInstall();
83 
85  CollectorMap m_collectors;
86 
88  Ptr<DataCollectionObject> m_aggregator;
89 
90  private:
92  Callback<void, uint8_t, double> m_traceSinkCallback;
93 
94 }; // end of class SatStatsFwdLinkSchedulerSymbolRateHelper
95 
96 } // end of namespace ns3
97 
98 #endif /* SATELLITE_STATS_FWD_LINK_SCHEDULER_SYMBOL_RATE_HELPER_H */
Parent abstract class of all satellite statistics helpers.
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.