satellite-scpc-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013 Magister Solutions Ltd
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 #ifndef SAT_FWD_LINK_SCHEDULER_SCPC_H
22 #define SAT_FWD_LINK_SCHEDULER_SCPC_H
23 
25 
26 #include <ns3/pointer.h>
27 
28 #include <stdint.h>
29 #include <utility>
30 #include <vector>
31 
32 namespace ns3
33 {
34 
49 {
50  public:
55  static TypeId GetTypeId(void);
56 
61  virtual TypeId GetInstanceTypeId(void) const;
62 
70 
78  SatScpcScheduler(Ptr<SatBbFrameConf> conf, Mac48Address address, double carrierBandwidthInHz);
79 
86 
92  virtual std::pair<Ptr<SatBbFrame>, const Time> GetNextFrame();
93 
94  private:
98  void DoDispose(void);
99 
103  void ScheduleBbFrames();
104 
108  void PeriodicTimerExpired();
109 
114 
121  void GetSchedulingObjects(std::vector<Ptr<SatSchedulingObject>>& output);
122 
126  Ptr<SatBbFrameContainer> m_bbFrameContainer;
127 
132 
137 
141  uint32_t m_symbolsSent;
142 };
143 
144 } // namespace ns3
145 
146 #endif /* SAT_FWD_LINK_SCHEDULER_SCPC_H */
SatFwdLinkSchedulerDefault schedules BB frames for forward link.
void SendAndClearSymbolsSentStat()
Send stats and reset all the symbols sent count for each slice to zero.
Ptr< SatBbFrameContainer > m_bbFrameContainer
The container for BB Frames.
~SatScpcScheduler()
Destroy a SatFwdLinkScheduler.
void DoDispose(void)
Do dispose actions.
uint32_t m_symbolsSent
The number of symbols sent for each slice during an allocation cycle.
Time m_schedulingStartThresholdTime
Threshold time of total transmissions in BB Frame container to trigger a scheduling round.
virtual std::pair< Ptr< SatBbFrame >, const Time > GetNextFrame()
Get next frame to be transmitted.
virtual TypeId GetInstanceTypeId(void) const
Get the type ID of instance.
static TypeId GetTypeId(void)
Get the type ID.
SatScpcScheduler()
Construct a SatFwdLinkScheduler.
void ScheduleBbFrames()
Schedule BB Frames.
void PeriodicTimerExpired()
Handles periodic timer timeouts.
Time m_schedulingStopThresholdTime
Threshold time of total transmissions in BB Frame container to stop a scheduling round.
void GetSchedulingObjects(std::vector< Ptr< SatSchedulingObject >> &output)
Gets scheduling object in sorted order according to configured sorting criteria.
SatArqSequenceNumber is handling the sequence numbers for the ARQ process.