• Overview
  • Examples
  • HowTos
  • Glossary
    • Classes | Public Types | Protected Member Functions | List of all members
    senf::emu::WirelessTransmitter Class Referenceabstract
    NetEmu interface API

    Transmit capable wireless interface base class. More...

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

    Inheritance diagram for senf::emu::WirelessTransmitter:
    Inheritance graph
    [legend]

    Classes

    struct  TxPower
     Transmit power table entry. More...
     

    Public Types

    typedef boost::iterator_range< TxPowers::const_iterator > TxPowersRange
     

    Protected Member Functions

     WirelessTransmitter (ppi::connector::PassiveInput<> &input)
     
     WirelessTransmitter (ppi::connector::PassiveInput< EthernetPacket > &input)
     
     WirelessTransmitter (ppi::connector::PassiveInputJack<> &input)
     
     WirelessTransmitter (ppi::connector::PassiveInputJack< EthernetPacket > &input)
     
    void init ()
     
    void registerTxPower (int power)
     
    void registerTxPower (int powerLower, int powerUpper)
     
    virtual ModulationParameter::id_t v_modulationId () const =0
     Called to get current modulation parameter configuration. More...
     
    virtual void v_modulationId (ModulationParameter::id_t id)=0
     Called to set modulation parameter configuration. More...
     
    virtual int v_txPower () const =0
     Called to get current transmit power. More...
     
    virtual void v_txPower (int power)=0
     Called to set transmit power. More...
     

    Wireless Modulation

    ModulationParameter::id_t modulation () const
     Get current modulation parameter configuration id. More...
     
    void modulation (ModulationParameter::id_t id)
     Set modulation parameter configuration by id. More...
     

    Transmit power

    int txPower () const
     Get current transmit power. More...
     
    void txPower (int power)
     Set transmit power. More...
     
    TxPowersRange txPowers () const
     Get valid transmit power ranges. More...
     

    Additional Inherited Members

    - Public Member Functions inherited from senf::emu::Transmitter
    virtual ~Transmitter ()
     
    unsigned mtu () const
     Get interface MTU. More...
     
    void mtu (unsigned v)
     Set interface MTU. More...
     
    void flushTxQueues ()
     Flush Tx Queues. More...
     
    - Public Attributes inherited from senf::emu::Transmitter
    ppi::connector::PassiveInputJack< EthernetPacket > input
     

    Detailed Description

    Transmit capable wireless interface base class.

    This base class adds txPower() and parameter() members which allow changing those parameters to the API.

    See also
    WirelessInterface
    NetEmu interface API

    Definition at line 296 of file WirelessInterfaceAPI.hh.

    Member Typedef Documentation

    ◆ TxPowersRange

    typedef boost::iterator_range<TxPowers::const_iterator> senf::emu::WirelessTransmitter::TxPowersRange

    Definition at line 322 of file WirelessInterfaceAPI.hh.

    Constructor & Destructor Documentation

    ◆ WirelessTransmitter() [1/4]

    senf::emu::WirelessTransmitter::WirelessTransmitter ( ppi::connector::PassiveInput<> &  input)
    		protected

    ◆ WirelessTransmitter() [2/4]

    senf::emu::WirelessTransmitter::WirelessTransmitter ( ppi::connector::PassiveInput< EthernetPacket > &  input)
    		protected

    ◆ WirelessTransmitter() [3/4]

    senf::emu::WirelessTransmitter::WirelessTransmitter ( ppi::connector::PassiveInputJack<> &  input)
    		protected

    ◆ WirelessTransmitter() [4/4]

    senf::emu::WirelessTransmitter::WirelessTransmitter ( ppi::connector::PassiveInputJack< EthernetPacket > &  input)
    		protected

    Member Function Documentation

    ◆ init()

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

    Definition at line 256 of file WirelessInterfaceAPI.cc.

    ◆ modulation() [1/2]

    senf::emu::ModulationParameter::id_t senf::emu::WirelessTransmitter::modulation ( ) const

    Get current modulation parameter configuration id.

    Definition at line 294 of file WirelessInterfaceAPI.cc.

    ◆ modulation() [2/2]

    void senf::emu::WirelessTransmitter::modulation ( ModulationParameter::id_t  id)

    Set modulation parameter configuration by id.

    Definition at line 300 of file WirelessInterfaceAPI.cc.

    ◆ registerTxPower() [1/2]

    void senf::emu::WirelessTransmitter::registerTxPower ( int  power)
    		protected

    Definition at line 307 of file WirelessInterfaceAPI.cc.

    ◆ registerTxPower() [2/2]

    void senf::emu::WirelessTransmitter::registerTxPower ( int  powerLower,
    int  powerUpper 
    )
    		protected

    Definition at line 312 of file WirelessInterfaceAPI.cc.

    ◆ txPower() [1/2]

    int senf::emu::WirelessTransmitter::txPower ( ) const

    Get current transmit power.

    ◆ txPower() [2/2]

    void senf::emu::WirelessTransmitter::txPower ( int  power)

    Set transmit power.

    ◆ txPowers()

    TxPowersRange senf::emu::WirelessTransmitter::txPowers ( ) const

    Get valid transmit power ranges.

    ◆ v_modulationId() [1/2]

    virtual ModulationParameter::id_t senf::emu::WirelessTransmitter::v_modulationId ( ) const
    		protectedpure virtual

    Called to get current modulation parameter configuration.

    ◆ v_modulationId() [2/2]

    virtual void senf::emu::WirelessTransmitter::v_modulationId ( ModulationParameter::id_t  id)
    		protectedpure virtual

    Called to set modulation parameter configuration.

    ◆ v_txPower() [1/2]

    virtual int senf::emu::WirelessTransmitter::v_txPower ( ) const
    		protectedpure virtual

    Called to get current transmit power.

    ◆ v_txPower() [2/2]

    virtual void senf::emu::WirelessTransmitter::v_txPower ( int  power)
    		protectedpure virtual

    Called to set transmit power.

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