Facade pattern for Virgil IoTKit Qt integration. More...
#include <VSQIoTKitFacade.h>
Inheritance diagram for VSQIoTKitFacade:
Collaboration diagram for VSQIoTKitFacade:
Public Types | |
| using | VSQSnapSnifferPtr = QSharedPointer< VSQSnapSnifferQml > |
| SNAP Sniffer pointer type. More... | |
Public Member Functions | |
| bool | init (const VSQFeatures &features, const VSQImplementations &impl, const VSQAppConfig &appConfig) |
| Facade initialization. More... | |
| VSQSnapSnifferPtr | snapSniffer () |
| Get installed sniffer. More... | |
| VSQSnapInfoClient * | snapInfoClient () |
| Get Snap INFO Client implementation. More... | |
Additional Inherited Members | |
 Static Public Member Functions inherited from VSQSingleton< VSQIoTKitFacade > | |
| static VSQIoTKitFacade & | instance () |
| Get static instance. More... | |
Detailed Description
Facade pattern for Virgil IoTKit Qt integration.
This class inherits QObject and VSQSingleton.
Initialize Virgil IoT KIT Qt by calling VSQIoTKitFacade::init function through its instance :
VSQIoTKitFacade::instance().init( ... )
Member Typedef Documentation
◆ VSQSnapSnifferPtr
| using VSQIoTKitFacade::VSQSnapSnifferPtr = QSharedPointer<VSQSnapSnifferQml> |
SNAP Sniffer pointer type.
Member Function Documentation
◆ init()
| bool VSQIoTKitFacade::init | ( | const VSQFeatures & | features, |
| const VSQImplementations & | impl, | ||
| const VSQAppConfig & | appConfig | ||
| ) |
Facade initialization.
Call this function to initialize Virgil IoT Kit facade.
- Parameters
-
features Application features impl Implementations to be used appConfig Application configuration
- Returns
- true if initialized successfully, false otherwise
◆ snapInfoClient()
| VSQSnapInfoClient* VSQIoTKitFacade::snapInfoClient | ( | ) |
Get Snap INFO Client implementation.
- Warning
- Function will return nullptr if Snap INFO Client feature is not enabled
- Returns
- Pointer to the VSQSnapInfoClient object or nullptr if Snap INFO Client feature is not enabled
◆ snapSniffer()
|
inline |
Get installed sniffer.
- Warning
- Function will return nullptr if sniffer is not initialized
- Returns
- VSQSnapSnifferQml object or nullptr if sniffer is not initialized
The documentation for this class was generated from the following file:
