Left: | ||
Right: |
LEFT | RIGHT |
---|---|
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ | 1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
2 /* | 2 /* |
3 * Copyright (c) 2015 Federico Guerra | 3 * Copyright (c) 2015 Federico Guerra |
4 * | 4 * |
5 * This program is free software; you can redistribute it and/or modify | 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 | 6 * it under the terms of the GNU General Public License version 2 as |
7 * published by the Free Software Foundation; | 7 * published by the Free Software Foundation; |
8 * | 8 * |
9 * This program is distributed in the hope that it will be useful, | 9 * This program is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
13 * | 13 * |
14 * You should have received a copy of the GNU General Public License | 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 | 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 | 16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
17 * | 17 * |
18 * Author: Federico Guerra <federico@guerra-tlc.com> | 18 * Author: Federico Guerra <federico@guerra-tlc.com> |
19 */ | 19 */ |
20 | 20 |
21 #ifdef NS3_WOSS_SUPPORT | 21 #ifdef NS3_WOSS_SUPPORT |
22 | 22 |
23 #ifndef WOSS_TIME_REFERENCE_H | 23 #ifndef WOSS_TIME_REFERENCE_H |
24 #define WOSS_TIME_REFERENCE_H | 24 #define WOSS_TIME_REFERENCE_H |
25 | 25 |
26 | 26 |
27 #include <time-definitions.h> | 27 #include <time-definitions.h> |
28 | 28 |
29 | 29 |
30 namespace ns3 | 30 namespace ns3 { |
31 { | 31 |
32 | |
33 /** | 32 /** |
34 * \class WossTimeReference | 33 * \class WossTimeReference |
35 * | 34 * |
36 * \brief Wrapper class for woss::TimeReference | 35 * \brief Wrapper class for woss::TimeReference |
37 * | 36 * |
38 * the class woss::TimeReference wraps the NS3 scheduler clock into the WOSS fram ework | 37 * the class woss::TimeReference wraps the NS3 scheduler clock into the WOSS fram ework |
39 * and it is used by the framework as a simulation time reference | 38 * and it is used as a simulation time reference. |
Tom Henderson
2016/04/25 17:45:06
please clarify, does it return the ns-3 Time as a
Fedwar
2016/04/30 21:18:09
correct double as unit of time.
clone is abstract
Fedwar
2016/05/01 09:38:39
the method must be implemented since it is abstrac
Tom Henderson
2016/05/07 14:57:52
OK, I suggest to add above comments to the Doxygen
Fedwar
2016/05/08 16:19:48
Done.
| |
40 */ | 39 * This class simply calls the static ns3::Simulator.Now (). |
41 class WossTimeReference : public woss::TimeReference { | 40 */ |
41 class WossTimeReference : public woss::TimeReference | |
42 { | |
42 | 43 |
43 | 44 |
44 public: | 45 public: |
45 ···· | |
46 ···· | |
47 virtual ~WossTimeReference (); | 46 virtual ~WossTimeReference (); |
48 ······ | 47 |
48 /** | |
49 * returns the current NS3 time in seconds represented as a double. | |
50 * \returns the current NS3 time in seconds in double representation | |
51 */ | |
49 virtual double getTimeReference () const; | 52 virtual double getTimeReference () const; |
50 | 53 |
51 virtual WossTimeReference* clone (); | 54 /** |
55 * Mandatory virtual factory method that returns a new WossTimeReference creat ed via | |
56 * copy-constructor. The new object will return the same time-reference as the source | |
57 * object since they both rely on ns3::Scheduler::Now () | |
58 */ | |
59 virtual WossTimeReference* clone (); | |
52 | 60 |
53 | 61 |
54 }; | 62 }; |
55 | 63 |
56 } | 64 } |
57 | 65 |
58 #endif // WOSS_TIME_REFERENCE_H | 66 #endif // WOSS_TIME_REFERENCE_H |
59 | 67 |
60 #endif /* NS3_WOSS_SUPPORT */ | 68 #endif /* NS3_WOSS_SUPPORT */ |
61 | 69 |
LEFT | RIGHT |