4S Device Communication Module Collection  Version 0.6-SNAPSHOT
Full documentation of the modules in the 4SDC collection (aimed at 4SDC module developers)
anonymous_namespace{bluedroid.cpp}::PhysicalDevice Class Reference
+ Inheritance diagram for anonymous_namespace{bluedroid.cpp}::PhysicalDevice:
+ Collaboration diagram for anonymous_namespace{bluedroid.cpp}::PhysicalDevice:

Public Member Functions

 PhysicalDevice (string displayName, string btAddress, string btName)
 
string getDisplayName () const noexcept
 A user-friendly name of the device. More...
 
string getBTAddress () const noexcept
 The bluetooth address of this device. More...
 
string getBTName () const noexcept
 The bluetooth name of this device. More...
 
- Public Member Functions inherited from PAL::PHDBluetoothDevice
 PHDBluetoothDevice ()
 Default constructor. More...
 
 PHDBluetoothDevice (FSYS::Handle &h)
 Constructor used to clone the handle. More...
 
- Public Member Functions inherited from PAL::PhysicalPHD
 PhysicalPHD ()
 Default constructor. More...
 
 PhysicalPHD (FSYS::Handle &h)
 Constructor used to clone the handle. More...
 
virtual ~PhysicalPHD ()
 Virtual destructor.
 
- Public Member Functions inherited from FSYS::Handle
 Handle (void)
 Default constructor. More...
 
 Handle (Handle &ref)
 Copy constructor for handle object. More...
 
 Handle (const Handle &ref)
 Copy constructor for handle object. More...
 
Handleoperator= (Handle const &theOtherOne)
 
bool operator== (Handle const &compareTo) const
 Equality comparator. More...
 
bool operator!= (Handle const &compareTo) const
 Not equalify operator. More...
 
bool operator> (Handle const &compareTo) const
 Greater than operator ('>') More...
 
bool operator< (Handle const &compareTo) const
 Less than operator ('<') More...
 

Public Attributes

string displayName
 
string btAddress
 
string btName
 

Additional Inherited Members

- Static Public Member Functions inherited from FSYS::Handle
static HandlebroadCastHandle (void)
 Generic broadcast handle. More...
 
static Handlenull (void)
 The null handle. More...
 

Member Function Documentation

string anonymous_namespace{bluedroid.cpp}::PhysicalDevice::getBTAddress ( ) const
inlinevirtualnoexcept

This getter will return the bluetooth address (a.k.a. MAC address) of this device. The format will be 6 double-digit hex values separated by colons, e.g.: "01:23:45:67:89:AB", so the string will always be 17 characters long.

Returns
The bluetooth address of this device.

Implements PAL::PHDBluetoothDevice.

string anonymous_namespace{bluedroid.cpp}::PhysicalDevice::getBTName ( ) const
inlinevirtualnoexcept

This getter will return the bluetooth name of this device. This may or may not be identical to the name returned by getDisplayName().

Returns
The bluetooth name of this device.

Implements PAL::PHDBluetoothDevice.

string anonymous_namespace{bluedroid.cpp}::PhysicalDevice::getDisplayName ( ) const
inlinevirtualnoexcept

This getter will return a user-friendly (or at least user-recognizable) name of the physical device, suitable for use in the user interface. Implementing classes should enforce consistent naming across other PAL layer interfaces (e.g. Bluetooth pairing, ZigBee network monitors and the like).

Bluetooth devices may (should?) grab the Service Name field of the SDP record; while USB devices may (should?) grab the name from the device descriptor's iProduct field.

Returns
The device name to be used in user interfaces.

Implements PAL::PhysicalPHD.


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