Class used to perform a GenICam firmware update on a device. More...

#include <PvGenFUUpdater.h>

Public Member Functions
	PvGenFUUpdater (const char aPath, const char aFileName, const PvDeviceInfo aDeviceInfo, const char aDeviceId, bool aDeviceReset)
	Constructor.

	~PvGenFUUpdater ()
	Destructor.

void	Attach (IUpdaterObserver *aObserver)
	Attach an observer.

void	Detach (IUpdaterObserver *aObserver)
	Detach observer.

void	Start ()
	Start the GenICam firmware update.

bool	IsDone () const
	Check if update has completed.

PvResult	GetResult () const
	Gets result of the update.

Detailed Description

Class used to perform a GenICam firmware update on a device.

The PvGenFUUpdater class can be used to perform a GenICam firmware update on a GigE Vision or USB3 Vision device.

The firmware update file must be a GenICam Update Format (.guf) file, or a Pleora zip updater file (.zip, also in GenICam Update Format).

Optionally, a new Device ID may be specified, and the device may be reset after the update is complete.

Constructor & Destructor Documentation

◆ PvGenFUUpdater()

PvGenFUUpdater::PvGenFUUpdater	(	const char *	aPath,
		const char *	aFileName,
		const PvDeviceInfo *	aDeviceInfo,
		const char *	aDeviceId,
		bool	aDeviceReset
	)

Constructor.

Parameters

[in]	aPath	Path of update file.
[in]	aFileName	Filename of update file.
[in]	aDeviceInfo	PvDeviceInfo of the device to be updated.
[in]	aDeviceId	New device ID, or empty if not to be changed.
[in]	aDeviceReset	True if device should be reset after update.

Member Function Documentation

◆ Attach()

void PvGenFUUpdater::Attach ( IUpdaterObserver * aObserver )

Attach an observer.

The application can receive messages and progress values for the GenICam firmware update. Attach an observer class and its UpdateProgressLabel and UpdateProgressValue methods will be called by the PvGenFUUpdater.

See also: Detach

◆ Detach()

void PvGenFUUpdater::Detach ( IUpdaterObserver * aObserver )

Detach observer.

Detaches an observer that was previously attached using Attach.

See also: Attach

◆ GetResult()

PvResult PvGenFUUpdater::GetResult ( ) const

Gets result of the update.

This should be called after IsDone returns true.

See also: Start; IsDone

◆ IsDone()

bool PvGenFUUpdater::IsDone ( ) const

Check if update has completed.

This can be called after Start to check if the update has completed. Returns true if the update has completed, false if the update is still going.

See also: Start; GetResult

◆ Start()

void PvGenFUUpdater::Start ( )

Start the GenICam firmware update.

The GenICam firmware update will begin after calling this method. This method will return immediately, it does not wait for the update to be completed. The application can periodically call IsDone to determine when the update has finished.

See also: IsDone

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

PvGenFUUpdater.h

eBUS SDK v7.0.1.7536 API

Public Member Functions