A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
spectrum-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) 2009 CTTC
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: Nicola Baldo <nbaldo@cttc.es>
19  */
20 
21 #ifndef SPECTRUM_PROPAGATION_LOSS_MODEL_H
22 #define SPECTRUM_PROPAGATION_LOSS_MODEL_H
23 
24 
25 #include <ns3/object.h>
26 #include <ns3/mobility-model.h>
27 #include <ns3/spectrum-value.h>
28 
29 namespace ns3 {
30 
31 
32 
33 
44 class SpectrumPropagationLossModel : public Object
45 {
46 public:
47  SpectrumPropagationLossModel ();
48  virtual ~SpectrumPropagationLossModel ();
49 
50  static TypeId GetTypeId ();
51 
52 
58  void SetNext (Ptr<SpectrumPropagationLossModel> next);
59 
74  Ptr<SpectrumValue> CalcRxPowerSpectralDensity (Ptr<const SpectrumValue> txPsd,
75  Ptr<const MobilityModel> a,
76  Ptr<const MobilityModel> b) const;
77 
78 protected:
79  virtual void DoDispose ();
80 
81 
82 private:
94  virtual Ptr<SpectrumValue> DoCalcRxPowerSpectralDensity (Ptr<const SpectrumValue> txPsd,
95  Ptr<const MobilityModel> a,
96  Ptr<const MobilityModel> b) const = 0;
97 
98  Ptr<SpectrumPropagationLossModel> m_next;
99 };
100 
101 
102 
103 
104 
105 
106 } // namespace ns3
107 
108 #endif /* SPECTRUM_PROPAGATION_LOSS_MODEL_H */
ns3::Ptr
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:59
ns3::SpectrumPropagationLossModel::DoDispose
virtual void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: spectrum-propagation-loss-model.cc:42
ns3::SpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity
virtual Ptr< SpectrumValue > DoCalcRxPowerSpectralDensity(Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const =0
ns3::SpectrumPropagationLossModel::m_next
Ptr< SpectrumPropagationLossModel > m_next
Definition: spectrum-propagation-loss-model.h:98
ns3::SpectrumPropagationLossModel::CalcRxPowerSpectralDensity
Ptr< SpectrumValue > CalcRxPowerSpectralDensity(Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
This method is to be called to calculate.
Definition: spectrum-propagation-loss-model.cc:64
ns3::SpectrumPropagationLossModel::SetNext
void SetNext(Ptr< SpectrumPropagationLossModel > next)
used to chain various instances of SpectrumPropagationLossModel
Definition: spectrum-propagation-loss-model.cc:57
ns3::SpectrumPropagationLossModel
spectrum-aware propagation loss model
Definition: spectrum-propagation-loss-model.h:44
ns3::Object
a base class which provides memory management and object aggregation
Definition: object.h:63
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:49