Mbed OS Reference
Loading...
Searching...
No Matches
ScanParameters::phy_configuration_t Struct Reference

Scan configuration of a physical channel. More...

#include <ScanParameters.h>

Public Member Functions

 phy_configuration_t (scan_interval_t scan_interval=scan_interval_t::min(), scan_window_t scan_window=scan_window_t::min(), bool active_scanning=false)
 Construct a phy_configuration_t. More...
 
const scan_interval_t & getInterval () const
 Get the scan interval. More...
 
const scan_window_t & getWindow () const
 Get the scan window. More...
 
bool isActiveScanningSet () const
 Return if active scanning is set. More...
 

Detailed Description

Scan configuration of a physical channel.

Definition at line 60 of file ScanParameters.h.

Constructor & Destructor Documentation

◆ phy_configuration_t()

phy_configuration_t ( scan_interval_t  scan_interval = scan_interval_t::min(),
scan_window_t  scan_window = scan_window_t::min(),
bool  active_scanning = false 
)

Construct a phy_configuration_t.

Parameters
scan_intervalThe scan interval.
scan_windowThe scan window.
active_scanningTrue if scan request should be sent and false otherwise.

Definition at line 68 of file ScanParameters.h.

Member Function Documentation

◆ getInterval()

const scan_interval_t & getInterval ( ) const

Get the scan interval.

Definition at line 85 of file ScanParameters.h.

◆ getWindow()

const scan_window_t & getWindow ( ) const

Get the scan window.

Definition at line 93 of file ScanParameters.h.

◆ isActiveScanningSet()

bool isActiveScanningSet ( ) const

Return if active scanning is set.

Definition at line 101 of file ScanParameters.h.