Emulated wireless interface base-class. More...

#include <senf/Ext/NetEmu/EmulatedWirelessInterface.hh>

Inheritance diagram for senf::emu::EmulatedWirelessInterface:

Public Types

typedef std::vector< console::ValueRange< unsigned > > Ranges
 
typedef boost::function< double(unsigned nodeId)> DistanceCallback
 

Public Member Functions

 ~EmulatedWirelessInterface ()
 
void registerFrequency (unsigned frequency, unsigned bandwidth)
 Register single frequency/bandwidth combination. More...
 
void registerFrequency (unsigned frequencyLower, unsigned frequencyUpper, unsigned bandwidthLower, unsigned bandwidthUpper)
 Register single frequency/bandwidth range. More...
 
void registerFrequency (Ranges const &frequencies, Ranges const &bandwidths)
 register frequency/bandwidth ranges More...
 
void distanceCallback (DistanceCallback cb)
 
- Public Member Functions inherited from senf::emu::EmulatedInterface
virtual ~EmulatedInterface ()
 
UDPClientHandle emulationSocket () const
 Get the emulation socket handle. More...
 
UDPClientHandle::Address emulationAddress () const
 Get current emulated traffic multicast address. More...
 
void emulationInterface (std::string const &interface)
 Set interface on which to send/receive emulated traffic. More...
 
std::string const & emulationInterface () const
 Get interface on which emulated traffic is sent/received. More...
 
std::uint32_t const & interfaceIndex () const
 

Protected Member Functions

 EmulatedWirelessInterface ()
 
void init ()
 
unsigned emulatedFrequency () const
 Get current emulated frequency. More...
 
unsigned emulatedBandwidth () const
 Get current emulated bandwidth. More...
 
void emulatedFrequency (unsigned frequency, unsigned bandwidth)
 Set channel frequency/bandwidth. More...
 
void emulatedCoverageRange (unsigned distance)
 
- Protected Member Functions inherited from senf::emu::EmulatedInterface
 EmulatedInterface ()
 
void init ()
 
void emulationAddress (UDPClientHandle::Address const &address)
 Change the emulated traffic multicast address. More...
 
void enableEmulatedInterface ()
 Enable the interface. More...
 
void disableEmulatedInterface ()
 Disable the interface. More...
 
bool emulatedInterfaceEnabled () const
 Get current interface state. More...
 
virtual void v_initEmulationInterface ()=0
 Called to initialize the emulated interface. More...
 
virtual void v_deinitEmulationInterface ()=0
 Called to shut down the emulated interface. More...
 

Detailed Description

Emulated wireless interface base-class.

This base class provides functionality to implement emulated wireless interfaces. It extends EmulatedInterface with public members to register frequencies and parameters.

In addition to this class, you need to use the EmulatedWirelessReceiver and/or EmulatedWirelessTransmitter base-classes.

Definition at line 302 of file EmulatedWirelessInterface.hh.

Member Typedef Documentation

◆ DistanceCallback

typedef boost::function<double (unsigned nodeId)> senf::emu::EmulatedWirelessInterface::DistanceCallback

Definition at line 313 of file EmulatedWirelessInterface.hh.

◆ Ranges

Definition at line 312 of file EmulatedWirelessInterface.hh.

Constructor & Destructor Documentation

◆ ~EmulatedWirelessInterface()

senf::emu::EmulatedWirelessInterface::~EmulatedWirelessInterface ( )

Definition at line 501 of file EmulatedWirelessInterface.cc.

◆ EmulatedWirelessInterface()

senf::emu::EmulatedWirelessInterface::EmulatedWirelessInterface ( )
protected

Member Function Documentation

◆ distanceCallback()

void senf::emu::EmulatedWirelessInterface::distanceCallback ( DistanceCallback  cb)

◆ emulatedBandwidth()

unsigned senf::emu::EmulatedWirelessInterface::emulatedBandwidth ( ) const
protected

Get current emulated bandwidth.

◆ emulatedCoverageRange()

void senf::emu::EmulatedWirelessInterface::emulatedCoverageRange ( unsigned  distance)
protected

Definition at line 561 of file EmulatedWirelessInterface.cc.

◆ emulatedFrequency() [1/2]

unsigned senf::emu::EmulatedWirelessInterface::emulatedFrequency ( ) const
protected

Get current emulated frequency.

◆ emulatedFrequency() [2/2]

void senf::emu::EmulatedWirelessInterface::emulatedFrequency ( unsigned  frequency,
unsigned  bandwidth 
)
protected

Set channel frequency/bandwidth.

Must be called by interface implementations v_frequency() member

Definition at line 548 of file EmulatedWirelessInterface.cc.

◆ init()

void senf::emu::EmulatedWirelessInterface::init ( )
protected

Definition at line 517 of file EmulatedWirelessInterface.cc.

◆ registerFrequency() [1/3]

void senf::emu::EmulatedWirelessInterface::registerFrequency ( unsigned  frequency,
unsigned  bandwidth 
)

Register single frequency/bandwidth combination.

◆ registerFrequency() [2/3]

void senf::emu::EmulatedWirelessInterface::registerFrequency ( unsigned  frequencyLower,
unsigned  frequencyUpper,
unsigned  bandwidthLower,
unsigned  bandwidthUpper 
)

Register single frequency/bandwidth range.

◆ registerFrequency() [3/3]

void senf::emu::EmulatedWirelessInterface::registerFrequency ( Ranges const &  frequencies,
Ranges const &  bandwidths 
)

register frequency/bandwidth ranges

Registers all possible combinations of each frequency or frequency range from frequencies with each bandwidth or bandwidth range from bandwidths. This command is normally called from the console.

Definition at line 509 of file EmulatedWirelessInterface.cc.


The documentation for this class was generated from the following files: