4S Device Communication Module Collection  Version 0.6-SNAPSHOT
Public interfaces of the modules in the 4SDC collection (aimed at users of the 4SDC modules)
Public Member Functions | List of all members
PAL::PHDBluetoothDevice Class Referenceabstract

Bluetooth specialization of the PersonalHealthDevice. More...

#include <personalhealthdevice.h>

+ Inheritance diagram for PAL::PHDBluetoothDevice:
+ Collaboration diagram for PAL::PHDBluetoothDevice:

Public Member Functions

 PHDBluetoothDevice ()
 Default constructor. More...
 
 PHDBluetoothDevice (FSYS::Handle &h)
 Constructor used to clone the handle. More...
 
virtual std::string getBTAddress () const noexcept=0
 The bluetooth address of this device. More...
 
virtual std::string getBTName () const noexcept=0
 The bluetooth name of this device. 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.
 
virtual std::string getDisplayName () const noexcept=0
 A user-friendly name of the device. More...
 
- 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...
 
Handle & operator= (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...
 

Additional Inherited Members

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

Detailed Description

This abstract class extends the PersonalHealthDevice with properties of the underlying bluetooth Health Device Profile (HDP) device, namely the bluetooth address and name.

Todo:
Describe how the HDP standard maps to this interface
See also
PersonalHealthDevice
PHDBluetoothConnector

Constructor & Destructor Documentation

PAL::PHDBluetoothDevice::PHDBluetoothDevice ( )
inline

The default constructor will create a PersonalHealthDevice object with a new unique FSYS::Handle.

PAL::PHDBluetoothDevice::PHDBluetoothDevice ( FSYS::Handle &  h)
inline

This alternative constructor will create a PersonalHealthDevice object with a cloned FSYS::Handle.

Member Function Documentation

virtual std::string PAL::PHDBluetoothDevice::getBTAddress ( ) const
pure virtualnoexcept

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.
virtual std::string PAL::PHDBluetoothDevice::getBTName ( ) const
pure virtualnoexcept

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.
The documentation for this class was generated from the following file: