BluetoothScannerConfiguration Class Reference

#include <bluetooth_scanner_configuration.hpp>

Data Structures
class	Builder

Public Types
enum	ScanConfiguration { ONE_SHOT, CYCLIC, CONTINUOUS, STOPPED }

Public Member Functions
	~BluetoothScannerConfiguration ()
	BluetoothScannerConfiguration (const BluetoothScannerConfiguration &configuration)
BluetoothScannerConfiguration &	operator= (const BluetoothScannerConfiguration &configuration)
	BluetoothScannerConfiguration (BluetoothScannerConfiguration &&configuration)
BluetoothScannerConfiguration &	operator= (BluetoothScannerConfiguration &&configuration)
ScanConfiguration	getScanConfiguration () const
std::chrono::seconds	getDuration () const
std::chrono::seconds	getCycleDuration () const
bool	getLegacyDiscovery () const

Friends
class	Builder

Detailed Description

Class that handles holds a scanner configuration.

Member Enumeration Documentation

ScanConfiguration

enum ScanConfiguration

strong

Available scan types.

They are not accessible to a developer. They are inferred according to the passed configurations to the Builder.

Enumerator
ONE_SHOT	A single scan. The scanner will got to STOPPED state after a de.sensry.kallisto.service.listeners.events.SystemEventType#SCAN_STOPPED event.
CYCLIC	The scanner will cycle continuously between scan on and off.
CONTINUOUS	The scanning will be continuous. A new STOPPED configuration is needed to stop the scanning.
STOPPED	The scanner is stopped.

Constructor & Destructor Documentation

~BluetoothScannerConfiguration()

~BluetoothScannerConfiguration

(

)

Destructor.

BluetoothScannerConfiguration() [1/2]

BluetoothScannerConfiguration

(

const BluetoothScannerConfiguration &

configuration

)

Copy Constructor.

BluetoothScannerConfiguration() [2/2]

BluetoothScannerConfiguration

(

BluetoothScannerConfiguration &&

configuration

)

Move Constructor.

Member Function Documentation

getCycleDuration()

std::chrono::seconds getCycleDuration

(

)

const

Get the configured scan cycle duration.

Represents the amount of time that the scanner waits after finishing a scan before starting a new scan.

Returns

A std::chrono::seconds detailing the scan cycle duration, in seconds.

getDuration()

std::chrono::seconds getDuration

(

)

const

Get the configured scan duration.

Returns

A std::chrono::seconds detailing the scan duration, in seconds.

getLegacyDiscovery()

bool getLegacyDiscovery

(

)

const

Get if legacy device discovery is enabled.

If this is enabled, the scanner will connect to the device in order to discover the device features, if the advertising data doesn't use the firmware SDK Advertising Manager.

Returns

true 

if legacy discovery is enabled.

getScanConfiguration()

ScanConfiguration getScanConfiguration

(

)

const

Get the configured scan configuration.

Returns

The configured ScanConfiguration.

operator=() [1/2]

BluetoothScannerConfiguration& operator=

(

const BluetoothScannerConfiguration &

configuration

)

Copy assigment operator.

operator=() [2/2]

BluetoothScannerConfiguration& operator=

(

BluetoothScannerConfiguration &&

configuration

)

Move assigment operator.

---

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

• /home/joao.oliveira/Workspace/local/repo/documentation/sphinx/source/components/kallistolinuxapi/include/bluetooth/scanner/bluetooth_scanner_configuration.hpp