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}::VirtualDevice Class Reference
+ Inheritance diagram for anonymous_namespace{bluedroid.cpp}::VirtualDevice:
+ Collaboration diagram for anonymous_namespace{bluedroid.cpp}::VirtualDevice:

Public Member Functions

 VirtualDevice (string displayName, uint16_t datatype, shared_ptr< PhysicalPHD > physicalDevice)
 
string getDisplayName () const noexcept
 A user-friendly name of the device. More...
 
uint16_t getDatatype () const noexcept
 The IEEE MDC_DEV_SPEC_PROFILE_ datatype implemented by this device. More...
 
PhysicalPHDgetPhysicalDevice () noexcept
 
const PhysicalPHDgetPhysicalDevice () const noexcept
 
- Public Member Functions inherited from PAL::VirtualPHD
 VirtualPHD ()
 Default constructor. More...
 
 VirtualPHD (FSYS::Handle &h)
 Constructor used to clone the handle. More...
 
virtual ~VirtualPHD ()
 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
 
uint16_t datatype
 
shared_ptr< PhysicalPHDphysicalDevice
 

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

uint16_t anonymous_namespace{bluedroid.cpp}::VirtualDevice::getDatatype ( ) const
inlinevirtualnoexcept

This getter will return the datatype implemented by this device. The datatype is a 16-bit unsigned integer – one of the MDC_DEV_SPEC_PROFILE_ codes belonging to the MDC_PART_INFRA partition.

Returns
The datatype implemented by this device.

Implements PAL::VirtualPHD.

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

This getter will return a user-friendly (or at least user-recognizable) name of the virtual 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 name from the optional MDEP Description field of the SDP record, if available; while USB devices may (should?) grab the name from the interface descriptor's iInterface field. If no name is available (including the case when the PAL component is not allowed to read these names), this name should be set to the empty string, and the user interface should be able to generate a default text based on the getDatatype() value.

Returns
The device name to be used in user interfaces, or "".

Implements PAL::VirtualPHD.


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