A Discrete-Event Network Simulator
API
cost231-propagation-loss-model.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2007,2008, 2009 INRIA, UDcast
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: Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
19  * <amine.ismail@udcast.com>
20  */
21 
22 #ifndef COST231_PROPAGATION_LOSS_MODEL_H
23 #define COST231_PROPAGATION_LOSS_MODEL_H
24 
25 #include "ns3/nstime.h"
26 #include "ns3/propagation-loss-model.h"
27 
28 namespace ns3 {
29 
51 {
52 
53 public:
58  static TypeId GetTypeId (void);
60 
67  double GetLoss (Ptr<MobilityModel> a, Ptr<MobilityModel> b) const;
68 
73  void SetBSAntennaHeight (double height);
78  void SetSSAntennaHeight (double height);
79 
84  void SetLambda (double lambda);
90  void SetLambda (double frequency, double speed);
95  void SetMinDistance (double minDistance);
100  double GetBSAntennaHeight (void) const;
105  double GetSSAntennaHeight (void) const;
110  double GetMinDistance (void) const;
115  double GetLambda (void) const;
120  double GetShadowing (void);
125  void SetShadowing (double shadowing);
126 private:
140 
141  double DoCalcRxPower (double txPowerDbm, Ptr<MobilityModel> a, Ptr<MobilityModel> b) const override;
142  int64_t DoAssignStreams (int64_t stream) override;
143 
146  double m_lambda;
147  double m_minDistance;
148  double m_frequency;
149  double m_shadowing;
150 };
151 
152 }
153 
154 #endif /* COST231PROPAGATIONMODEL_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::Cost231PropagationLossModel::m_minDistance
double m_minDistance
minimum distance [m]
Definition: cost231-propagation-loss-model.h:147
ns3::Cost231PropagationLossModel::GetMinDistance
double GetMinDistance(void) const
Get the minimum model distance.
Definition: cost231-propagation-loss-model.cc:113
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::Cost231PropagationLossModel::Cost231PropagationLossModel
Cost231PropagationLossModel(const Cost231PropagationLossModel &)
Copy constructor.
ns3::Cost231PropagationLossModel::m_lambda
double m_lambda
The wavelength.
Definition: cost231-propagation-loss-model.h:146
ns3::Cost231PropagationLossModel::DoAssignStreams
int64_t DoAssignStreams(int64_t stream) override
Subclasses must implement this; those not using random variables can return zero.
Definition: cost231-propagation-loss-model.cc:178
ns3::Cost231PropagationLossModel::SetSSAntennaHeight
void SetSSAntennaHeight(double height)
Set the SS antenna height.
Definition: cost231-propagation-loss-model.cc:131
ns3::PropagationLossModel
Models the propagation loss through a transmission medium.
Definition: propagation-loss-model.h:50
ns3::Cost231PropagationLossModel::m_frequency
double m_frequency
frequency [Hz]
Definition: cost231-propagation-loss-model.h:148
ns3::Cost231PropagationLossModel::GetShadowing
double GetShadowing(void)
Get the shadowing value.
Definition: cost231-propagation-loss-model.cc:84
ns3::Cost231PropagationLossModel::SetBSAntennaHeight
void SetBSAntennaHeight(double height)
Set the BS antenna height.
Definition: cost231-propagation-loss-model.cc:119
ns3::Cost231PropagationLossModel::SetMinDistance
void SetMinDistance(double minDistance)
Set the minimum model distance.
Definition: cost231-propagation-loss-model.cc:108
ns3::Ptr< MobilityModel >
ns3::Cost231PropagationLossModel::SetShadowing
void SetShadowing(double shadowing)
Set the shadowing value.
Definition: cost231-propagation-loss-model.cc:89
ns3::Cost231PropagationLossModel::m_SSAntennaHeight
double m_SSAntennaHeight
SS Antenna Height [m].
Definition: cost231-propagation-loss-model.h:145
ns3::Cost231PropagationLossModel::Cost231PropagationLossModel
Cost231PropagationLossModel()
Definition: cost231-propagation-loss-model.cc:71
ns3::Cost231PropagationLossModel::m_BSAntennaHeight
double m_BSAntennaHeight
BS Antenna Height [m].
Definition: cost231-propagation-loss-model.h:144
ns3::Cost231PropagationLossModel::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: cost231-propagation-loss-model.cc:37
ns3::Cost231PropagationLossModel::GetBSAntennaHeight
double GetBSAntennaHeight(void) const
Get the BS antenna height.
Definition: cost231-propagation-loss-model.cc:125
ns3::Cost231PropagationLossModel::GetLambda
double GetLambda(void) const
Get the wavelength.
Definition: cost231-propagation-loss-model.cc:102
ns3::Cost231PropagationLossModel::GetLoss
double GetLoss(Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
Get the propagation loss.
Definition: cost231-propagation-loss-model.cc:143
ns3::Cost231PropagationLossModel::GetSSAntennaHeight
double GetSSAntennaHeight(void) const
Get the SS antenna height.
Definition: cost231-propagation-loss-model.cc:137
ns3::Cost231PropagationLossModel::DoCalcRxPower
double DoCalcRxPower(double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
Returns the Rx Power taking into account only the particular PropagationLossModel.
Definition: cost231-propagation-loss-model.cc:172
ns3::Cost231PropagationLossModel::SetLambda
void SetLambda(double lambda)
Set the wavelength.
Definition: cost231-propagation-loss-model.cc:95
ns3::Cost231PropagationLossModel::m_shadowing
double m_shadowing
Shadowing loss [dB].
Definition: cost231-propagation-loss-model.h:149
ns3::Cost231PropagationLossModel
The COST-Hata-Model is the most often cited of the COST 231 models.
Definition: cost231-propagation-loss-model.h:51
ns3::Cost231PropagationLossModel::operator=
Cost231PropagationLossModel & operator=(const Cost231PropagationLossModel &)
Copy constructor.