libhomegear-base  0.7
Base library for Homegear and Homegear family modules.
BaseLib::DeviceDescription::SupportedDevice Class Reference

#include <SupportedDevice.h>

Public Member Functions

 SupportedDevice (BaseLib::SharedObjects *baseLib)
 
 SupportedDevice (BaseLib::SharedObjects *baseLib, xml_node *node)
 
virtual ~SupportedDevice ()=default
 
bool matches (const std::string &typeId)
 
bool matches (uint64_t typeNumber, uint32_t firmwareVersion)
 
bool checkFirmwareVersion (int32_t version)
 Checks if a firmware version matches this device description. More...
 

Public Attributes

std::string id
 
std::string productId
 
std::string hardwareVersion
 
std::string manufacturer
 
std::string description
 
std::string longDescription
 
std::string serialPrefix
 
uint64_t typeNumber = 0
 
uint32_t minFirmwareVersion = 0
 
uint32_t maxFirmwareVersion = 0
 

Protected Attributes

BaseLib::SharedObjects_bl = nullptr
 

Constructor & Destructor Documentation

§ SupportedDevice() [1/2]

BaseLib::DeviceDescription::SupportedDevice::SupportedDevice ( BaseLib::SharedObjects baseLib)
explicit

§ SupportedDevice() [2/2]

BaseLib::DeviceDescription::SupportedDevice::SupportedDevice ( BaseLib::SharedObjects baseLib,
xml_node node 
)
explicit

§ ~SupportedDevice()

virtual BaseLib::DeviceDescription::SupportedDevice::~SupportedDevice ( )
virtualdefault

Member Function Documentation

§ checkFirmwareVersion()

bool BaseLib::DeviceDescription::SupportedDevice::checkFirmwareVersion ( int32_t  version)

Checks if a firmware version matches this device description.

Parameters
versionThe firmware version to check or "-1".
Returns
Returns true if the firmware version is within minFirmwareVersion and maxFirmwareVersion or if it is -1.

§ matches() [1/2]

bool BaseLib::DeviceDescription::SupportedDevice::matches ( const std::string &  typeId)

§ matches() [2/2]

bool BaseLib::DeviceDescription::SupportedDevice::matches ( uint64_t  typeNumber,
uint32_t  firmwareVersion 
)

Member Data Documentation

§ _bl

BaseLib::SharedObjects* BaseLib::DeviceDescription::SupportedDevice::_bl = nullptr
protected

§ description

std::string BaseLib::DeviceDescription::SupportedDevice::description

§ hardwareVersion

std::string BaseLib::DeviceDescription::SupportedDevice::hardwareVersion

§ id

std::string BaseLib::DeviceDescription::SupportedDevice::id

§ longDescription

std::string BaseLib::DeviceDescription::SupportedDevice::longDescription

§ manufacturer

std::string BaseLib::DeviceDescription::SupportedDevice::manufacturer

§ maxFirmwareVersion

uint32_t BaseLib::DeviceDescription::SupportedDevice::maxFirmwareVersion = 0

§ minFirmwareVersion

uint32_t BaseLib::DeviceDescription::SupportedDevice::minFirmwareVersion = 0

§ productId

std::string BaseLib::DeviceDescription::SupportedDevice::productId

§ serialPrefix

std::string BaseLib::DeviceDescription::SupportedDevice::serialPrefix

§ typeNumber

uint64_t BaseLib::DeviceDescription::SupportedDevice::typeNumber = 0

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