INET Framework for OMNeT++/OMNEST
inet::ieee80211::Ieee80211Prim_ScanRequest Class Reference

Class generated from inet/linklayer/ieee80211/mgmt/Ieee80211Primitives.msg:94 by opp_msgtool. More...

#include <Ieee80211Primitives_m.h>

Inheritance diagram for inet::ieee80211::Ieee80211Prim_ScanRequest:
inet::ieee80211::Ieee80211PrimRequest

Public Member Functions

 Ieee80211Prim_ScanRequest ()
 
 Ieee80211Prim_ScanRequest (const Ieee80211Prim_ScanRequest &other)
 
virtual ~Ieee80211Prim_ScanRequest ()
 
Ieee80211Prim_ScanRequestoperator= (const Ieee80211Prim_ScanRequest &other)
 
virtual Ieee80211Prim_ScanRequestdup () const override
 
virtual void parsimPack (omnetpp::cCommBuffer *b) const override
 
virtual void parsimUnpack (omnetpp::cCommBuffer *b) override
 
virtual Ieee80211BssType getBSSType () const
 
virtual void setBSSType (Ieee80211BssType BSSType)
 
virtual const ::inet::MacAddressgetBSSID () const
 
virtual ::inet::MacAddressgetBSSIDForUpdate ()
 
virtual void setBSSID (const ::inet::MacAddress &BSSID)
 
virtual const char * getSSID () const
 
virtual void setSSID (const char *SSID)
 
virtual bool getActiveScan () const
 
virtual void setActiveScan (bool activeScan)
 
virtual ::omnetpp::simtime_t getProbeDelay () const
 
virtual void setProbeDelay (::omnetpp::simtime_t probeDelay)
 
virtual void setChannelListArraySize (size_t size)
 
virtual size_t getChannelListArraySize () const
 
virtual int getChannelList (size_t k) const
 
virtual void setChannelList (size_t k, int channelList)
 
virtual void insertChannelList (size_t k, int channelList)
 
void insertChannelList (int channelList)
 
virtual void appendChannelList (int channelList)
 
virtual void eraseChannelList (size_t k)
 
virtual ::omnetpp::simtime_t getMinChannelTime () const
 
virtual void setMinChannelTime (::omnetpp::simtime_t minChannelTime)
 
virtual ::omnetpp::simtime_t getMaxChannelTime () const
 
virtual void setMaxChannelTime (::omnetpp::simtime_t maxChannelTime)
 
- Public Member Functions inherited from inet::ieee80211::Ieee80211PrimRequest
 Ieee80211PrimRequest ()
 
 Ieee80211PrimRequest (const Ieee80211PrimRequest &other)
 
virtual ~Ieee80211PrimRequest ()
 
Ieee80211PrimRequestoperator= (const Ieee80211PrimRequest &other)
 

Protected Member Functions

bool operator== (const Ieee80211Prim_ScanRequest &)=delete
 
- Protected Member Functions inherited from inet::ieee80211::Ieee80211PrimRequest
bool operator== (const Ieee80211PrimRequest &)=delete
 

Protected Attributes

Ieee80211BssType BSSType = static_cast<inet::ieee80211::Ieee80211BssType>(-1)
 
::inet::MacAddress BSSID
 
::omnetpp::opp_string SSID
 
bool activeScan = false
 
::omnetpp::simtime_t probeDelay = SIMTIME_ZERO
 
int * channelList = nullptr
 
size_t channelList_arraysize = 0
 
::omnetpp::simtime_t minChannelTime = SIMTIME_ZERO
 
::omnetpp::simtime_t maxChannelTime = SIMTIME_ZERO
 

Private Member Functions

void copy (const Ieee80211Prim_ScanRequest &other)
 

Detailed Description

Class generated from inet/linklayer/ieee80211/mgmt/Ieee80211Primitives.msg:94 by opp_msgtool.

//
// Losely based on MLME-SCAN.request.
//
class Ieee80211Prim_ScanRequest extends Ieee80211PrimRequest
{
    Ieee80211BssType BSSType; // determines type of BSS's to include in the scan
    MacAddress BSSID; // specific BSSID to scan for (default: any)
    string SSID;      // SSID to scan for SSID (default: any)
    bool activeScan;  // whether to perform active or passive scanning
    simtime_t probeDelay; // delay (in �s) to be used prior to transmitting a Probe frame during active scanning
    int channelList[]; // list of channels to scan (default: all channels)
    simtime_t minChannelTime; // minimum time to spend on each channel when scanning
    simtime_t maxChannelTime; // maximum time to spend on each channel when scanning
}

Constructor & Destructor Documentation

◆ Ieee80211Prim_ScanRequest() [1/2]

inet::ieee80211::Ieee80211Prim_ScanRequest::Ieee80211Prim_ScanRequest ( )

◆ Ieee80211Prim_ScanRequest() [2/2]

inet::ieee80211::Ieee80211Prim_ScanRequest::Ieee80211Prim_ScanRequest ( const Ieee80211Prim_ScanRequest other)

◆ ~Ieee80211Prim_ScanRequest()

virtual inet::ieee80211::Ieee80211Prim_ScanRequest::~Ieee80211Prim_ScanRequest ( )
virtual

Member Function Documentation

◆ appendChannelList()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::appendChannelList ( int  channelList)
virtual

◆ copy()

void inet::ieee80211::Ieee80211Prim_ScanRequest::copy ( const Ieee80211Prim_ScanRequest other)
private

◆ dup()

virtual Ieee80211Prim_ScanRequest* inet::ieee80211::Ieee80211Prim_ScanRequest::dup ( ) const
inlineoverridevirtual

Reimplemented from inet::ieee80211::Ieee80211PrimRequest.

292 {return new Ieee80211Prim_ScanRequest(*this);}

◆ eraseChannelList()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::eraseChannelList ( size_t  k)
virtual

◆ getActiveScan()

virtual bool inet::ieee80211::Ieee80211Prim_ScanRequest::getActiveScan ( ) const
virtual

◆ getBSSID()

virtual const ::inet::MacAddress& inet::ieee80211::Ieee80211Prim_ScanRequest::getBSSID ( ) const
virtual

◆ getBSSIDForUpdate()

virtual ::inet::MacAddress& inet::ieee80211::Ieee80211Prim_ScanRequest::getBSSIDForUpdate ( )
inline
300 { return const_cast<::inet::MacAddress&>(const_cast<Ieee80211Prim_ScanRequest*>(this)->getBSSID());}

◆ getBSSType()

virtual Ieee80211BssType inet::ieee80211::Ieee80211Prim_ScanRequest::getBSSType ( ) const
virtual

◆ getChannelList()

virtual int inet::ieee80211::Ieee80211Prim_ScanRequest::getChannelList ( size_t  k) const
virtual

◆ getChannelListArraySize()

virtual size_t inet::ieee80211::Ieee80211Prim_ScanRequest::getChannelListArraySize ( ) const
virtual

◆ getMaxChannelTime()

virtual ::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::getMaxChannelTime ( ) const

◆ getMinChannelTime()

virtual ::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::getMinChannelTime ( ) const

◆ getProbeDelay()

virtual ::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::getProbeDelay ( ) const

◆ getSSID()

virtual const char* inet::ieee80211::Ieee80211Prim_ScanRequest::getSSID ( ) const
virtual

◆ insertChannelList() [1/2]

void inet::ieee80211::Ieee80211Prim_ScanRequest::insertChannelList ( int  channelList)
inline

◆ insertChannelList() [2/2]

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::insertChannelList ( size_t  k,
int  channelList 
)
virtual

◆ operator=()

Ieee80211Prim_ScanRequest& inet::ieee80211::Ieee80211Prim_ScanRequest::operator= ( const Ieee80211Prim_ScanRequest other)

◆ operator==()

bool inet::ieee80211::Ieee80211Prim_ScanRequest::operator== ( const Ieee80211Prim_ScanRequest )
protecteddelete

◆ parsimPack()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::parsimPack ( omnetpp::cCommBuffer *  b) const
overridevirtual

◆ parsimUnpack()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::parsimUnpack ( omnetpp::cCommBuffer *  b)
overridevirtual

◆ setActiveScan()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setActiveScan ( bool  activeScan)
virtual

◆ setBSSID()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setBSSID ( const ::inet::MacAddress BSSID)
virtual

◆ setBSSType()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setBSSType ( Ieee80211BssType  BSSType)
virtual

◆ setChannelList()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setChannelList ( size_t  k,
int  channelList 
)
virtual

◆ setChannelListArraySize()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setChannelListArraySize ( size_t  size)
virtual

◆ setMaxChannelTime()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setMaxChannelTime ( ::omnetpp::simtime_t  maxChannelTime)
virtual

◆ setMinChannelTime()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setMinChannelTime ( ::omnetpp::simtime_t  minChannelTime)
virtual

◆ setProbeDelay()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setProbeDelay ( ::omnetpp::simtime_t  probeDelay)
virtual

◆ setSSID()

virtual void inet::ieee80211::Ieee80211Prim_ScanRequest::setSSID ( const char *  SSID)
virtual

Member Data Documentation

◆ activeScan

bool inet::ieee80211::Ieee80211Prim_ScanRequest::activeScan = false
protected

◆ BSSID

::inet::MacAddress inet::ieee80211::Ieee80211Prim_ScanRequest::BSSID
protected

◆ BSSType

Ieee80211BssType inet::ieee80211::Ieee80211Prim_ScanRequest::BSSType = static_cast<inet::ieee80211::Ieee80211BssType>(-1)
protected

◆ channelList

int* inet::ieee80211::Ieee80211Prim_ScanRequest::channelList = nullptr
protected

◆ channelList_arraysize

size_t inet::ieee80211::Ieee80211Prim_ScanRequest::channelList_arraysize = 0
protected

◆ maxChannelTime

::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::maxChannelTime = SIMTIME_ZERO
protected

◆ minChannelTime

::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::minChannelTime = SIMTIME_ZERO
protected

◆ probeDelay

::omnetpp::simtime_t inet::ieee80211::Ieee80211Prim_ScanRequest::probeDelay = SIMTIME_ZERO
protected

◆ SSID

::omnetpp::opp_string inet::ieee80211::Ieee80211Prim_ScanRequest::SSID
protected

The documentation for this class was generated from the following file:
inet::ieee80211::Ieee80211Prim_ScanRequest::channelList
int * channelList
Definition: Ieee80211Primitives_m.h:276
inet::ieee80211::Ieee80211Prim_ScanRequest::appendChannelList
virtual void appendChannelList(int channelList)
inet::ieee80211::Ieee80211Prim_ScanRequest::Ieee80211Prim_ScanRequest
Ieee80211Prim_ScanRequest()
inet::ieee80211::Ieee80211Prim_ScanRequest::getBSSID
virtual const ::inet::MacAddress & getBSSID() const
inet::MacAddress
Stores an IEEE 802 MAC address (6 octets = 48 bits).
Definition: MacAddress.h:24