Firmware updater class.
More...
#include <cvb/genapi/fw_updater.hpp>
Firmware updater class.
- Example
-
◆ FWUpdater()
Construct a firmware updater, Validate a guf file and set the location of the guf file as CVB::String.
- Note
- Unused files or procedures that are part of the guf file are currently tolerated.
- Parameters
-
[in] | filename | Path and name of the guf file to be applied to the camera. |
[in] | verify | If true the guf file will be validated. |
- Exceptions
-
◆ AvailableGufInfo()
Collects all key value pairs available in a guf file.
- Returns
- std::map with key value pair.
◆ AvailableUpdateFiles()
Collects all mandatory update file infos available in a guf file.
- Returns
- std::vector<String> with update file description and version.
◆ Create()
Create a firmware updater, Validate a guf file and set the location of the guf file as CVB::String.
- Note
- Unused files or procedures that are part of the guf file are currently tolerated.
- Parameters
-
[in] | filename | Path and name of the guf file to be applied to the camera. |
[in] | verify | If true the guf file will be validated. |
- Returns
- A pointer to the firmware updater
- Exceptions
-
◆ FromHandle()
Creates a firmware updater from a classic API handle.
- Parameters
-
[in] | guard | Life time guard for C-API handle. |
[in] | filename | name of the updater guf file. |
- Returns
- The firmware updater created from the classic API handle.
- Exceptions
-
The firmware updater takes ownership of the handle, so you must share it before using this function.
◆ Handle()
Classic API node map handle.
- Returns
- Classic API handle.
- Exceptions
-
Does | not throw any exception. |
It is normally not necessary to work with this handle.
◆ Update()
void Update |
( |
DevicePtr && |
device, |
|
|
const size_t |
updateFileSelection |
|
) |
| |
|
inline |
Update the device.
- Parameters
-
[in] | device | Device to update. |
[in] | updateFileSelection | Index of guf file update to apply to device. |
- Exceptions
-
◆ UpdateFileCount()
size_t UpdateFileCount |
( |
| ) |
|
|
inline |
Gets the number of available update files in a guf file.
- Returns
- Number of available firmware update files in the guf file.
- Exceptions
-
◆ UpdateFileInfo()
Identifies a single firmware update and gets information about the firmware update as CVB::String.
- Parameters
-
[in] | fileIndex | Index of update file within guf file. |
[in] | infoIndex | Index of information within update file. |
[in] | cmd | Command to identify the information to be retrieved. |
- Returns
- Info string with requested information.
◆ UpdateFileInfoCount()
size_t UpdateFileInfoCount |
( |
const size_t & |
fileIndex | ) |
|
|
inline |
Gets the number of available update infos in a guf file.
- Parameters
-
[in] | fileIndex | Index of update file within guf to read infos from. |
- Returns
- Number of available firmware update infos.
- Exceptions
-
◆ UpdateFileInfos()
Collects all information on a single update file available in a guf file.
- Returns
- std::vector<String> with update file description and version.