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 */
An identifier for simulation events.
Definition: event-id.h:54
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
a unique identifier for an interface.
Definition: type-id.h:59
Class consisting of packet arrival information (Time, RxPower, mode, PDP).
The power delay profile returned by propagation models.
Half duplex implementation of transducer object.
void EndTx(void)
Handle end of transmission event.
virtual bool IsTx(void) const
Is the state transmitting?
virtual void DoDispose()
Destructor implementation.
virtual void SetRxGainDb(double gainDb)
Set the receiver gain.
State m_state
Transducer state.
bool m_cleared
Flab when we've been cleared.
virtual void Clear(void)
Clears all pointer references.
virtual void Transmit(Ptr< UanPhy > src, Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)
Transmit a packet from this transducer.
double m_rxGainDb
Receive gain in dB.
Ptr< UanChannel > m_channel
The attached channel.
ArrivalList m_arrivalList
List of arriving packets which overlap in time.
virtual bool IsRx(void) const
Is the state receiving (or available for reception)?
void RemoveArrival(UanPacketArrival arrival)
Remove an entry from the arrival list.
virtual State GetState(void) const
Get the transducer state.
virtual const ArrivalList & GetArrivalList(void) const
Get the list of overlapped (in time) packets at this transducer.
virtual void AddPhy(Ptr< UanPhy >)
Attach a physical network layer above this transducer.
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.
EventId m_endTxEvent
Event scheduled for end of transmission.
virtual Ptr< UanChannel > GetChannel(void) const
Get the attached channel.
virtual double GetRxGainDb(void)
Get the receiver gain added to signal at receiver in dB.
UanTransducerHd()
Constructor.
virtual const UanPhyList & GetPhyList(void) const
Get the list of physical layer above this transducer.
virtual ~UanTransducerHd()
Dummy destructor, see DoDispose.
Time m_endTxTime
Time at which transmission will be completed.
static TypeId GetTypeId(void)
Register this type.
virtual void SetChannel(Ptr< UanChannel > chan)
Attach this transducer to a channel.
virtual double ApplyRxGainDb(double rxPowerDb, UanTxMode mode)
Apply receiver gain in dB to the received power.
UanPhyList m_phyList
List of physical layers attached above this tranducer.
Virtual base for Transducer objects.
State
Transducer state.
std::list< Ptr< UanPhy > > UanPhyList
List of UanPhy objects.
std::list< UanPacketArrival > ArrivalList
List of arriving packets overlapping in time.
Abstraction of packet modulation information.
Definition: uan-tx-mode.h:42
Every class exported by the ns3 library is enclosed in the ns3 namespace.