IDS peak genericC++  v1.5.0
Public Member Functions | Friends | List of all members
peak::core::FirmwareUpdateInformation Class Reference

Represents a single firmware update information. More...

#include <peak/device/peak_firmware_update_information.hpp>

Public Member Functions

 FirmwareUpdateInformation ()=delete
 
 ~FirmwareUpdateInformation ()=default
 
 FirmwareUpdateInformation (const FirmwareUpdateInformation &other)=delete
 
FirmwareUpdateInformation & operator= (const FirmwareUpdateInformation &other)=delete
 
 FirmwareUpdateInformation (FirmwareUpdateInformation &&other)=delete
 
FirmwareUpdateInformation & operator= (FirmwareUpdateInformation &&other)=delete
 
bool IsValid () const
 Checks whether the information held are valid. More...
 
std::string FileName () const
 Returns the file name of the package this firmware update information belongs to. More...
 
std::string Description () const
 Returns the description of the firmware update. More...
 
std::string Version () const
 Returns the version of the firmware update. More...
 
std::string VersionExtractionPattern () const
 Regular expression to extract the device version from the DeviceFirmwareVersion node. More...
 
FirmwareUpdateVersionStyle VersionStyle () const
 The style of the Version() value. More...
 
std::string ReleaseNotes () const
 Release notes of the firmware update. More...
 
std::string ReleaseNotesURL () const
 A link to a webpage with more release notes. More...
 
FirmwareUpdatePersistence UserSetPersistence () const
 Specifies if the device persists user sets during the update. More...
 
FirmwareUpdatePersistence SequencerSetPersistence () const
 Specifies if the device persists sequencer sets during the update. More...
 

Friends

class FirmwareUpdater
 

Detailed Description

Represents a single firmware update information.

This class allows to query information from the *.guf file about a single firmware update information.

See GenICam FWUpdate Standard.

Constructor & Destructor Documentation

◆ FirmwareUpdateInformation() [1/3]

peak::core::FirmwareUpdateInformation::FirmwareUpdateInformation ( )
delete

◆ ~FirmwareUpdateInformation()

peak::core::FirmwareUpdateInformation::~FirmwareUpdateInformation ( )
default

◆ FirmwareUpdateInformation() [2/3]

peak::core::FirmwareUpdateInformation::FirmwareUpdateInformation ( const FirmwareUpdateInformation &  other)
delete

◆ FirmwareUpdateInformation() [3/3]

peak::core::FirmwareUpdateInformation::FirmwareUpdateInformation ( FirmwareUpdateInformation &&  other)
delete

Member Function Documentation

◆ Description()

std::string peak::core::FirmwareUpdateInformation::Description ( ) const
inline

Returns the description of the firmware update.

Returns
Description
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ FileName()

std::string peak::core::FirmwareUpdateInformation::FileName ( ) const
inline

Returns the file name of the package this firmware update information belongs to.

Returns
File name
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ IsValid()

bool peak::core::FirmwareUpdateInformation::IsValid ( ) const
inline

Checks whether the information held are valid.

Returns
True, if the information held are valid.
False otherwise.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ operator=() [1/2]

FirmwareUpdateInformation& peak::core::FirmwareUpdateInformation::operator= ( const FirmwareUpdateInformation &  other)
delete

◆ operator=() [2/2]

FirmwareUpdateInformation& peak::core::FirmwareUpdateInformation::operator= ( FirmwareUpdateInformation &&  other)
delete

◆ ReleaseNotes()

std::string peak::core::FirmwareUpdateInformation::ReleaseNotes ( ) const
inline

Release notes of the firmware update.

Returns
Release notes
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ ReleaseNotesURL()

std::string peak::core::FirmwareUpdateInformation::ReleaseNotesURL ( ) const
inline

A link to a webpage with more release notes.

This webpage can contain addition details not contained in ReleaseNotes().

Returns
URL where the release notes of the firmware update can be found
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ SequencerSetPersistence()

FirmwareUpdatePersistence peak::core::FirmwareUpdateInformation::SequencerSetPersistence ( ) const
inline

Specifies if the device persists sequencer sets during the update.

Returns
Sequencer set persistence
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ UserSetPersistence()

FirmwareUpdatePersistence peak::core::FirmwareUpdateInformation::UserSetPersistence ( ) const
inline

Specifies if the device persists user sets during the update.

Returns
User set persistence
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ Version()

std::string peak::core::FirmwareUpdateInformation::Version ( ) const
inline

Returns the version of the firmware update.

Returns
Version
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ VersionExtractionPattern()

std::string peak::core::FirmwareUpdateInformation::VersionExtractionPattern ( ) const
inline

Regular expression to extract the device version from the DeviceFirmwareVersion node.

The first matched group is used as result. This is needed for devices which encode more information than just the firmware version inside the DeviceFirmwareVersion node. The default value is: ^(.*)$

Returns
Version extraction pattern
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ VersionStyle()

FirmwareUpdateVersionStyle peak::core::FirmwareUpdateInformation::VersionStyle ( ) const
inline

The style of the Version() value.

This is needed to actually interpret and sort the versions. Using this information an update software is able to inform the user if an update would actually be a downgrade or if it was already applied to the device.

Returns
Version style
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

Friends And Related Function Documentation

◆ FirmwareUpdater

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