A Discrete-Event Network Simulator
API
propagation-delay-model.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005,2006,2007 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef PROPAGATION_DELAY_MODEL_H
21 #define PROPAGATION_DELAY_MODEL_H
22 
23 #include "ns3/ptr.h"
24 #include "ns3/object.h"
25 #include "ns3/nstime.h"
26 #include "ns3/random-variable-stream.h"
27 
28 namespace ns3 {
29 
30 class MobilityModel;
31 
38 {
39 public:
44  static TypeId GetTypeId (void);
45  virtual ~PropagationDelayModel ();
64  int64_t AssignStreams (int64_t stream);
65 protected:
70  virtual int64_t DoAssignStreams (int64_t stream) = 0;
71 };
72 
79 {
80 public:
85  static TypeId GetTypeId (void);
86 
92  Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const override;
93 private:
94  int64_t DoAssignStreams (int64_t stream) override;
96 };
97 
104 {
105 public:
110  static TypeId GetTypeId (void);
111 
116  Time GetDelay (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const override;
120  void SetSpeed (double speed);
124  double GetSpeed (void) const;
125 private:
126  int64_t DoAssignStreams (int64_t stream) override;
127  double m_speed;
128 };
129 
130 } // namespace ns3
131 
132 #endif /* PROPAGATION_DELAY_MODEL_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::ConstantSpeedPropagationDelayModel
the propagation speed is constant
Definition: propagation-delay-model.h:104
ns3::ConstantSpeedPropagationDelayModel::GetSpeed
double GetSpeed(void) const
Definition: propagation-delay-model.cc:122
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::RandomPropagationDelayModel::~RandomPropagationDelayModel
virtual ~RandomPropagationDelayModel()
Definition: propagation-delay-model.cc:73
ns3::PropagationDelayModel::DoAssignStreams
virtual int64_t DoAssignStreams(int64_t stream)=0
Subclasses must implement this; those not using random variables can return zero.
ns3::PropagationDelayModel
calculate a propagation delay.
Definition: propagation-delay-model.h:38
ns3::ConstantSpeedPropagationDelayModel::ConstantSpeedPropagationDelayModel
ConstantSpeedPropagationDelayModel()
Use the default parameters from PropagationDelayConstantSpeed.
Definition: propagation-delay-model.cc:106
ns3::RandomPropagationDelayModel::GetDelay
Time GetDelay(Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
Definition: propagation-delay-model.cc:77
ns3::Ptr< MobilityModel >
ns3::ConstantSpeedPropagationDelayModel::m_speed
double m_speed
speed
Definition: propagation-delay-model.h:127
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::PropagationDelayModel::GetDelay
virtual Time GetDelay(Ptr< MobilityModel > a, Ptr< MobilityModel > b) const =0
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::RandomPropagationDelayModel
the propagation delay is random
Definition: propagation-delay-model.h:79
ns3::PropagationDelayModel::~PropagationDelayModel
virtual ~PropagationDelayModel()
Definition: propagation-delay-model.cc:40
ns3::RandomPropagationDelayModel::DoAssignStreams
int64_t DoAssignStreams(int64_t stream) override
Subclasses must implement this; those not using random variables can return zero.
Definition: propagation-delay-model.cc:83
ns3::ConstantSpeedPropagationDelayModel::GetDelay
Time GetDelay(Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
Definition: propagation-delay-model.cc:110
ns3::RandomPropagationDelayModel::RandomPropagationDelayModel
RandomPropagationDelayModel()
Use the default parameters from PropagationDelayRandomDistribution.
Definition: propagation-delay-model.cc:70
ns3::ConstantSpeedPropagationDelayModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: propagation-delay-model.cc:92
ns3::RandomPropagationDelayModel::m_variable
Ptr< RandomVariableStream > m_variable
random generator
Definition: propagation-delay-model.h:95
ns3::ConstantSpeedPropagationDelayModel::SetSpeed
void SetSpeed(double speed)
Definition: propagation-delay-model.cc:117
ns3::RandomPropagationDelayModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: propagation-delay-model.cc:55
ns3::ConstantSpeedPropagationDelayModel::DoAssignStreams
int64_t DoAssignStreams(int64_t stream) override
Subclasses must implement this; those not using random variables can return zero.
Definition: propagation-delay-model.cc:128
ns3::PropagationDelayModel::AssignStreams
int64_t AssignStreams(int64_t stream)
If this delay model uses objects of type RandomVariableStream, set the stream numbers to the integers...
Definition: propagation-delay-model.cc:45
ns3::PropagationDelayModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: propagation-delay-model.cc:31