Base class for UAN Phy models.
More...
#include <uan-phy.h>
List of all members.
Public Types |
enum | State { IDLE,
CCABUSY,
RX,
TX
} |
| Enum defining possible Phy states.
|
typedef Callback< void, Ptr
< Packet >, double, UanTxMode > | RxOkCallback |
typedef Callback< void, Ptr
< Packet >, double > | RxErrCallback |
Public Member Functions |
virtual void | SendPacket (Ptr< Packet > pkt, uint32_t modeNum)=0 |
virtual void | RegisterListener (UanPhyListener *listener)=0 |
virtual void | StartRxPacket (Ptr< Packet > pkt, double rxPowerDb, UanTxMode txMode, UanPdp pdp)=0 |
| Packet arriving from channel: i.e. leading bit of packet has arrived.
|
virtual void | SetReceiveOkCallback (RxOkCallback cb)=0 |
virtual void | SetReceiveErrorCallback (RxErrCallback cb)=0 |
virtual void | SetRxGainDb (double gain)=0 |
virtual void | SetTxPowerDb (double txpwr)=0 |
virtual void | SetRxThresholdDb (double thresh)=0 |
virtual void | SetCcaThresholdDb (double thresh)=0 |
virtual double | GetRxGainDb (void)=0 |
virtual double | GetTxPowerDb (void)=0 |
virtual double | GetRxThresholdDb (void)=0 |
virtual double | GetCcaThresholdDb (void)=0 |
virtual bool | IsStateIdle (void)=0 |
virtual bool | IsStateBusy (void)=0 |
virtual bool | IsStateRx (void)=0 |
virtual bool | IsStateTx (void)=0 |
virtual bool | IsStateCcaBusy (void)=0 |
virtual Ptr< UanChannel > | GetChannel (void) const =0 |
virtual Ptr< UanNetDevice > | GetDevice (void)=0 |
virtual void | SetChannel (Ptr< UanChannel > channel)=0 |
virtual void | SetDevice (Ptr< UanNetDevice > device)=0 |
virtual void | SetMac (Ptr< UanMac > mac)=0 |
virtual void | NotifyTransStartTx (Ptr< Packet > packet, double txPowerDb, UanTxMode txMode)=0 |
virtual void | NotifyIntChange (void)=0 |
virtual void | SetTransducer (Ptr< UanTransducer > trans)=0 |
virtual Ptr< UanTransducer > | GetTransducer (void)=0 |
virtual uint32_t | GetNModes (void)=0 |
virtual UanTxMode | GetMode (uint32_t n)=0 |
virtual Ptr< Packet > | GetPacketRx (void) const =0 |
virtual void | Clear (void)=0 |
Detailed Description
Base class for UAN Phy models.
Member Typedef Documentation
arg1: packet received successfully arg2: snr of packet
arg1: packet received successfully arg2: snr of packet arg3: mode of packet
Member Function Documentation
virtual void ns3::UanPhy::Clear |
( |
void |
|
) |
[pure virtual] |
virtual double ns3::UanPhy::GetCcaThresholdDb |
( |
void |
|
) |
[pure virtual] |
virtual Ptr<UanChannel> ns3::UanPhy::GetChannel |
( |
void |
|
) |
const [pure virtual] |
virtual UanTxMode ns3::UanPhy::GetMode |
( |
uint32_t |
n |
) |
[pure virtual] |
virtual uint32_t ns3::UanPhy::GetNModes |
( |
void |
|
) |
[pure virtual] |
virtual Ptr<Packet> ns3::UanPhy::GetPacketRx |
( |
void |
|
) |
const [pure virtual] |
virtual double ns3::UanPhy::GetRxGainDb |
( |
void |
|
) |
[pure virtual] |
virtual double ns3::UanPhy::GetRxThresholdDb |
( |
void |
|
) |
[pure virtual] |
virtual double ns3::UanPhy::GetTxPowerDb |
( |
void |
|
) |
[pure virtual] |
virtual bool ns3::UanPhy::IsStateBusy |
( |
void |
|
) |
[pure virtual] |
virtual bool ns3::UanPhy::IsStateCcaBusy |
( |
void |
|
) |
[pure virtual] |
virtual bool ns3::UanPhy::IsStateIdle |
( |
void |
|
) |
[pure virtual] |
virtual bool ns3::UanPhy::IsStateRx |
( |
void |
|
) |
[pure virtual] |
virtual bool ns3::UanPhy::IsStateTx |
( |
void |
|
) |
[pure virtual] |
virtual void ns3::UanPhy::NotifyIntChange |
( |
void |
|
) |
[pure virtual] |
Function called when there has been a change in the ammount of interference this node is experiencing from other transmissions
Implemented in ns3::UanPhyDual, and ns3::UanPhyGen.
virtual void ns3::UanPhy::NotifyTransStartTx |
( |
Ptr< Packet > |
packet, |
|
|
double |
txPowerDb, |
|
|
UanTxMode |
txMode | |
|
) |
| | [pure virtual] |
- Parameters:
-
| packet | Packet that is beginning transmission |
| txPowerDb | Transmit power of packet |
| txMode | Transmission mode of packet |
Notification that there is a transmission beginning on the transducer that this Phy is attached to.
Implemented in ns3::UanPhyDual, and ns3::UanPhyGen.
virtual void ns3::UanPhy::RegisterListener |
( |
UanPhyListener * |
listener |
) |
[pure virtual] |
- Parameters:
-
| listener | New listener to register |
Register an object to be notified of common Phy events
Implemented in ns3::UanPhyDual, and ns3::UanPhyGen.
virtual void ns3::UanPhy::SendPacket |
( |
Ptr< Packet > |
pkt, |
|
|
uint32_t |
modeNum | |
|
) |
| | [pure virtual] |
virtual void ns3::UanPhy::SetCcaThresholdDb |
( |
double |
thresh |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetChannel |
( |
Ptr< UanChannel > |
channel |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetDevice |
( |
Ptr< UanNetDevice > |
device |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetMac |
( |
Ptr< UanMac > |
mac |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetReceiveErrorCallback |
( |
RxErrCallback |
cb |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetReceiveOkCallback |
( |
RxOkCallback |
cb |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetRxGainDb |
( |
double |
gain |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetRxThresholdDb |
( |
double |
thresh |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetTransducer |
( |
Ptr< UanTransducer > |
trans |
) |
[pure virtual] |
virtual void ns3::UanPhy::SetTxPowerDb |
( |
double |
txpwr |
) |
[pure virtual] |
virtual void ns3::UanPhy::StartRxPacket |
( |
Ptr< Packet > |
pkt, |
|
|
double |
rxPowerDb, |
|
|
UanTxMode |
txMode, |
|
|
UanPdp |
pdp | |
|
) |
| | [pure virtual] |
Packet arriving from channel: i.e. leading bit of packet has arrived.
- Parameters:
-
| pkt | Packet which is arriving |
| rxPowerDb | Signal power of incoming packet in dB |
| txMode | Transmission mode defining modulation of incoming packet |
| pdp | Power delay profile of incoming packet |
Implemented in ns3::UanPhyDual, and ns3::UanPhyGen.
The documentation for this class was generated from the following file:
- src/devices/uan/model/uan-phy.h