Identifies a single firmware update and holds information about the firmware update. More...
#include <FirmwareUpdateInfo.h>
Public Member Functions | |
CFirmwareUpdateInfo () | |
Creates an empty CFirmwareUpdateInfo object. More... | |
CFirmwareUpdateInfo (const CFirmwareUpdateInfo &Rhs) | |
Creates a copy of CFirmwareUpdateInfo object. More... | |
GENICAM_NAMESPACE::gcstring | ExtractVersionFromDeviceFirmwareVersion (const GENICAM_NAMESPACE::gcstring &DeviceFirmwareVersionFromDevice) const |
Extracts the firmware version using the device firmware version and the regular expression provided by the key FirmwareUpdateInfoKey_VersionExtractionPattern. More... | |
size_t | GetCountOfInfos () const |
Returns the count of available key value pairs. More... | |
const char * | GetInfo (const char *InfoKey) const |
Returns the value for an info key name. More... | |
const char * | GetInfo (const char *InfoKey, const char *pDefaultValueIfNotAvailable) const |
Returns the value for an info key name. More... | |
const char * | GetInfo (size_t Index) const |
Returns the value for the given index. More... | |
const char * | GetInfoKey (size_t Index) const |
Returns the key name for the given index. More... | |
const char * | GetInfoLanguageCode (const char *InfoKey) const |
Returns the ISO 639-1 language code for a key name, e.g. More... | |
const char * | GetUpdateFilename () const |
Returns the source file of an firmware update. More... | |
bool | IsValid () const |
Checks if valid information is held. More... | |
CFirmwareUpdateInfo & | operator= (const CFirmwareUpdateInfo &Rhs) |
Creates a copy of CFirmwareUpdateInfo object. More... | |
bool | operator== (const CFirmwareUpdateInfo &Rhs) const |
Compares two CFirmwareUpdateInfo objects. More... | |
~CFirmwareUpdateInfo () | |
Destroys the CFirmwareUpdateInfo object. More... | |
Protected Attributes | |
CFirmwareUpdateInfoImpl * | m_pImpl |
Identifies a single firmware update and holds information about the firmware update.
The CFirmwareUpdateInfo class is not thread-safe.
Definition at line 72 of file FirmwareUpdateInfo.h.
GENAPI_NAMESPACE::CFirmwareUpdateInfo::CFirmwareUpdateInfo | ( | ) |
Creates an empty CFirmwareUpdateInfo object.
CFirmwareUpdateInfo::IsValid() will return false. Valid CFirmwareUpdateInfo() objects are created by calling CFirmwareUpdater::ReadFirmwareUpdateInfos().
Does not throw C++ exceptions, except when memory allocation fails.
GENAPI_NAMESPACE::CFirmwareUpdateInfo::CFirmwareUpdateInfo | ( | const CFirmwareUpdateInfo & | Rhs | ) |
Creates a copy of CFirmwareUpdateInfo object.
[in] | Rhs | The object to copy. The CFirmwareUpdateInfo class uses reference counting. It is freely copyable without copying the held data. This helps to keep this class in different containers to support creating different views on update info when handling multiple updates and update files. |
Does not throw C++ exceptions.
GENAPI_NAMESPACE::CFirmwareUpdateInfo::~CFirmwareUpdateInfo | ( | ) |
Destroys the CFirmwareUpdateInfo object.
Does not throw C++ exceptions.
GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFirmwareUpdateInfo::ExtractVersionFromDeviceFirmwareVersion | ( | const GENICAM_NAMESPACE::gcstring & | DeviceFirmwareVersionFromDevice | ) | const |
Extracts the firmware version using the device firmware version and the regular expression provided by the key FirmwareUpdateInfoKey_VersionExtractionPattern.
[in] | DeviceFirmwareVersionFromDevice | The device version from the DeviceFirmwareVersion node value of a device. |
Throws a RuntimeException if the regular expression match fails. Throws a LogicalErrorException if the keys FirmwareUpdateInfoKey_VersionStyle and FirmwareUpdateInfoKey_VersionExtractionPattern are not available.
size_t GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetCountOfInfos | ( | ) | const |
Returns the count of available key value pairs.
Does not throw C++ exceptions.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetInfo | ( | const char * | InfoKey | ) | const |
Returns the value for an info key name.
[in] | InfoKey | The key name, e.g. FirmwareUpdateInfoKey_Description. |
Does not throw C++ exceptions.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetInfo | ( | const char * | InfoKey, |
const char * | pDefaultValueIfNotAvailable | ||
) | const |
Returns the value for an info key name.
[in] | InfoKey | The key name, e.g. FirmwareUpdateInfoKey_Description. |
[in] | pDefaultValueIfNotAvailable | The default to return if the key it is not available. |
pDefaultValueIfNotAvailable
if the key it is not available.Does not throw C++ exceptions.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetInfo | ( | size_t | Index | ) | const |
Returns the value for the given index.
[in] | Index | The key value pair index. |
Throws an InvalidArgumentException
if the given Index
is out of bounds.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetInfoKey | ( | size_t | Index | ) | const |
Returns the key name for the given index.
[in] | Index | The key value pair index. |
Throws an InvalidArgumentException
if the given Index
is out of bounds.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetInfoLanguageCode | ( | const char * | InfoKey | ) | const |
Returns the ISO 639-1 language code for a key name, e.g.
"de".
[in] | InfoKey | The key name, e.g. FirmwareUpdateInfoKey_Description. |
Does not throw C++ exceptions.
const char* GENAPI_NAMESPACE::CFirmwareUpdateInfo::GetUpdateFilename | ( | ) | const |
Returns the source file of an firmware update.
Does not throw C++ exceptions.
bool GENAPI_NAMESPACE::CFirmwareUpdateInfo::IsValid | ( | ) | const |
Checks if valid information is held.
Does not throw C++ exceptions.
CFirmwareUpdateInfo& GENAPI_NAMESPACE::CFirmwareUpdateInfo::operator= | ( | const CFirmwareUpdateInfo & | Rhs | ) |
Creates a copy of CFirmwareUpdateInfo object.
[in] | Rhs | The object to assign. The CFirmwareUpdateInfo class uses reference counting. It is freely copyable without copying the held data. This helps to keep this class in different containers to support creating different views on update info when handling multiple updates and update files. |
Does not throw C++ exceptions.
bool GENAPI_NAMESPACE::CFirmwareUpdateInfo::operator== | ( | const CFirmwareUpdateInfo & | Rhs | ) | const |
Compares two CFirmwareUpdateInfo objects.
Returns true if absolute identical information is held.
[in] | Rhs | The object to compare with this object. |
Does not throw C++ exceptions.
|
protected |
Definition at line 217 of file FirmwareUpdateInfo.h.