A Discrete-Event Network Simulator
API
uan-transducer-hd.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 University of Washington
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: Leonard Tracy <lentracy@gmail.com>
19  */
20 
21 #ifndef UAN_TRANSDUCER_HD_H
22 #define UAN_TRANSDUCER_HD_H
23 
24 #include "uan-transducer.h"
25 #include "ns3/simulator.h"
26 namespace ns3 {
27 
37 {
38 public:
40  UanTransducerHd ();
42  virtual ~UanTransducerHd ();
43 
48  static TypeId GetTypeId (void);
49 
50  // inherited methods
51  virtual State GetState (void) const;
52  virtual bool IsRx (void) const;
53  virtual bool IsTx (void) const;
54  virtual const ArrivalList &GetArrivalList (void) const;
55  virtual double ApplyRxGainDb (double rxPowerDb, UanTxMode mode);
56  virtual void SetRxGainDb (double gainDb);
57  virtual double GetRxGainDb (void);
58  virtual void Receive (Ptr<Packet> packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp);
59  virtual void Transmit (Ptr<UanPhy> src, Ptr<Packet> packet, double txPowerDb, UanTxMode txMode);
60  virtual void SetChannel (Ptr<UanChannel> chan);
61  virtual Ptr<UanChannel> GetChannel (void) const;
62  virtual void AddPhy (Ptr<UanPhy>);
63  virtual const UanPhyList &GetPhyList (void) const;
64  virtual void Clear (void);
65 
66 private:
73  bool m_cleared;
74  double m_rxGainDb;
75 
81  void RemoveArrival (UanPacketArrival arrival);
83  void EndTx (void);
84 protected:
85  virtual void DoDispose ();
86 
87 }; // class UanTransducerHd
88 
89 } // namespace ns3
90 
91 #endif /* UAN_TRANSDUCER_HD_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::UanTransducerHd::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: uan-transducer-hd.cc:83
ns3::EventId
An identifier for simulation events.
Definition: event-id.h:54
ns3::UanPdp
The power delay profile returned by propagation models.
Definition: uan-prop-model.h:92
ns3::UanTransducerHd::m_endTxTime
Time m_endTxTime
Time at which transmission will be completed.
Definition: uan-transducer-hd.h:72
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::UanTransducerHd::m_arrivalList
ArrivalList m_arrivalList
List of arriving packets which overlap in time.
Definition: uan-transducer-hd.h:68
ns3::UanTransducerHd
Half duplex implementation of transducer object.
Definition: uan-transducer-hd.h:37
ns3::UanTransducerHd::UanTransducerHd
UanTransducerHd()
Constructor.
Definition: uan-transducer-hd.cc:36
ns3::UanTransducerHd::GetArrivalList
virtual const ArrivalList & GetArrivalList(void) const
Get the list of overlapped (in time) packets at this transducer.
Definition: uan-transducer-hd.cc:125
ns3::UanTransducerHd::m_cleared
bool m_cleared
Flab when we've been cleared.
Definition: uan-transducer-hd.h:73
ns3::UanTransducerHd::GetRxGainDb
virtual double GetRxGainDb(void)
Get the receiver gain added to signal at receiver in dB.
Definition: uan-transducer-hd.cc:137
ns3::UanTransducerHd::ApplyRxGainDb
virtual double ApplyRxGainDb(double rxPowerDb, UanTxMode mode)
Apply receiver gain in dB to the received power.
Definition: uan-transducer-hd.cc:143
ns3::UanTransducerHd::SetChannel
virtual void SetChannel(Ptr< UanChannel > chan)
Attach this transducer to a channel.
Definition: uan-transducer-hd.cc:232
uan-transducer.h
ns3::Ptr< Packet >
ns3::UanTransducer::UanPhyList
std::list< Ptr< UanPhy > > UanPhyList
List of UanPhy objects.
Definition: uan-transducer.h:156
ns3::UanPacketArrival
Class consisting of packet arrival information (Time, RxPower, mode, PDP).
Definition: uan-transducer.h:43
ns3::UanTransducerHd::Clear
virtual void Clear(void)
Clears all pointer references.
Definition: uan-transducer-hd.cc:50
ns3::UanTransducerHd::SetRxGainDb
virtual void SetRxGainDb(double gainDb)
Set the receiver gain.
Definition: uan-transducer-hd.cc:131
ns3::UanTransducerHd::GetChannel
virtual Ptr< UanChannel > GetChannel(void) const
Get the attached channel.
Definition: uan-transducer-hd.cc:239
ns3::UanTransducerHd::IsTx
virtual bool IsTx(void) const
Is the state transmitting?
Definition: uan-transducer-hd.cc:118
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::UanTransducerHd::Receive
virtual void Receive(Ptr< Packet > packet, double rxPowerDb, UanTxMode txMode, UanPdp pdp)
Notify this object that a new packet has arrived at this nodes location.
Definition: uan-transducer-hd.cc:152
ns3::UanTxMode
Abstraction of packet modulation information.
Definition: uan-tx-mode.h:42
ns3::UanTransducer::State
State
Transducer state.
Definition: uan-transducer.h:148
ns3::UanTransducerHd::IsRx
virtual bool IsRx(void) const
Is the state receiving (or available for reception)?
Definition: uan-transducer-hd.cc:112
ns3::UanTransducerHd::RemoveArrival
void RemoveArrival(UanPacketArrival arrival)
Remove an entry from the arrival list.
Definition: uan-transducer-hd.cc:256
ns3::UanTransducerHd::m_state
State m_state
Transducer state.
Definition: uan-transducer-hd.h:67
ns3::UanTransducerHd::m_rxGainDb
double m_rxGainDb
Receive gain in dB.
Definition: uan-transducer-hd.h:74
ns3::UanTransducerHd::m_channel
Ptr< UanChannel > m_channel
The attached channel.
Definition: uan-transducer-hd.h:70
ns3::UanTransducer::ArrivalList
std::list< UanPacketArrival > ArrivalList
List of arriving packets overlapping in time.
Definition: uan-transducer.h:154
ns3::UanTransducerHd::GetPhyList
virtual const UanPhyList & GetPhyList(void) const
Get the list of physical layer above this transducer.
Definition: uan-transducer-hd.cc:250
ns3::UanTransducerHd::AddPhy
virtual void AddPhy(Ptr< UanPhy >)
Attach a physical network layer above this transducer.
Definition: uan-transducer-hd.cc:244
ns3::UanTransducerHd::m_phyList
UanPhyList m_phyList
List of physical layers attached above this tranducer.
Definition: uan-transducer-hd.h:69
ns3::UanTransducerHd::~UanTransducerHd
virtual ~UanTransducerHd()
Dummy destructor, see DoDispose.
Definition: uan-transducer-hd.cc:45
ns3::UanTransducerHd::GetState
virtual State GetState(void) const
Get the transducer state.
Definition: uan-transducer-hd.cc:105
ns3::UanTransducer
Virtual base for Transducer objects.
Definition: uan-transducer.h:139
ns3::UanTransducerHd::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: uan-transducer-hd.cc:89
ns3::UanTransducerHd::EndTx
void EndTx(void)
Handle end of transmission event.
Definition: uan-transducer-hd.cc:225
ns3::UanTransducerHd::Transmit
virtual void Transmit(Ptr< UanPhy > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)
Transmit a packet from this transducer.
Definition: uan-transducer-hd.cc:184
ns3::UanTransducerHd::m_endTxEvent
EventId m_endTxEvent
Event scheduled for end of transmission.
Definition: uan-transducer-hd.h:71