senf::emu::ModulationParameter Struct Referenceabstract

Wireless modulation parameter. More...

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

Inheritance diagram for senf::emu::ModulationParameter:

Classes

struct  Error
 

Public Types

typedef boost::uint32_t id_t
 

Public Member Functions

 ModulationParameter (std::string const &_coding, short _minRssi, unsigned _rate, unsigned _bandwidth, boost::uint8_t _linkTypeId, std::string const &_info="")
 
virtual ~ModulationParameter ()
 
void dump (std::ostream &os) const
 
void dumpTableHeader (std::ostream &os) const
 
void dumpTableRow (std::ostream &os, bool is_current_modulation) const
 
bool operator< (ModulationParameter const &other) const
 
bool operator== (ModulationParameter const &other) const
 

Public Attributes

id_t id
 unique identifier More...
 
std::string coding
 
short minRssi
 Minimum RSSI value. More...
 
unsigned rate
 Bitrate in kbit/s. More...
 
unsigned bandwidth
 Bandwidth in KHz. More...
 
boost::uint8_t linkTypeId
 
std::string info
 Arbitrary additional information. More...
 

Detailed Description

Wireless modulation parameter.

Every wireless modulation parameter describes a unique combination of internal wireless parameters like coding, rate or FEC. The exact interpretation depends on the interface type.

See also
senf::emu::WirelessInterface
senf::emu::ModulationParameterRegistry

Definition at line 45 of file WirelessInterfaceAPI.hh.

Member Typedef Documentation

◆ id_t

typedef boost::uint32_t senf::emu::ModulationParameter::id_t

Definition at line 49 of file WirelessInterfaceAPI.hh.

Constructor & Destructor Documentation

◆ ModulationParameter()

senf::emu::ModulationParameter::ModulationParameter ( std::string const &  _coding,
short  _minRssi,
unsigned  _rate,
unsigned  _bandwidth,
boost::uint8_t  _linkTypeId,
std::string const &  _info = "" 
)

Definition at line 30 of file WirelessInterfaceAPI.cc.

◆ ~ModulationParameter()

virtual senf::emu::ModulationParameter::~ModulationParameter ( )
inlinevirtual

Definition at line 59 of file WirelessInterfaceAPI.hh.

Member Function Documentation

◆ dump()

void senf::emu::ModulationParameter::dump ( std::ostream &  os) const

Definition at line 56 of file WirelessInterfaceAPI.cc.

◆ dumpTableHeader()

void senf::emu::ModulationParameter::dumpTableHeader ( std::ostream &  os) const

Definition at line 67 of file WirelessInterfaceAPI.cc.

◆ dumpTableRow()

void senf::emu::ModulationParameter::dumpTableRow ( std::ostream &  os,
bool  is_current_modulation 
) const

Definition at line 76 of file WirelessInterfaceAPI.cc.

◆ operator<()

bool senf::emu::ModulationParameter::operator< ( ModulationParameter const &  other) const
inline

Definition at line 69 of file WirelessInterfaceAPI.hh.

◆ operator==()

bool senf::emu::ModulationParameter::operator== ( ModulationParameter const &  other) const
inline

Definition at line 73 of file WirelessInterfaceAPI.hh.

Member Data Documentation

◆ bandwidth

unsigned senf::emu::ModulationParameter::bandwidth

Bandwidth in KHz.

Definition at line 54 of file WirelessInterfaceAPI.hh.

◆ coding

std::string senf::emu::ModulationParameter::coding

Definition at line 51 of file WirelessInterfaceAPI.hh.

◆ id

id_t senf::emu::ModulationParameter::id

unique identifier

Definition at line 50 of file WirelessInterfaceAPI.hh.

◆ info

std::string senf::emu::ModulationParameter::info

Arbitrary additional information.

Definition at line 56 of file WirelessInterfaceAPI.hh.

◆ linkTypeId

boost::uint8_t senf::emu::ModulationParameter::linkTypeId

Definition at line 55 of file WirelessInterfaceAPI.hh.

◆ minRssi

short senf::emu::ModulationParameter::minRssi

Minimum RSSI value.

Definition at line 52 of file WirelessInterfaceAPI.hh.

◆ rate

unsigned senf::emu::ModulationParameter::rate

Bitrate in kbit/s.

Definition at line 53 of file WirelessInterfaceAPI.hh.


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