GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver Class Reference

Represents a firmware update observer. More...

#include <FirmwareUpdateProgressObserver.h>

Inheritance diagram for GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver:

Public Member Functions
virtual void	OnFirmwareUpdateBegin (const CFirmwareUpdateInfo &FirmwareUpdateInfo, unsigned int EstimatedDurationMs)=0
	Signal the start of a firmware update. More...
virtual void	OnFirmwareUpdateEnd ()=0
	Signal the end of a firmware update. More...
virtual void	OnFirmwareUpdateError (const GENICAM_NAMESPACE::GenericException &TheError)=0
	Signal that an error occurred during firmware update (between OnFirmwareUpdateBegin() and OnFirmwareUpdateEnd()). More...
virtual void	OnFirmwareUpdateProgressStepBegin (EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs, const char *Description)=0
	Signal the start of a single firmware update step. More...
virtual void	OnFirmwareUpdateProgressStepEnd (EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs)=0
	Signal the end of a single firmware update step. More...
virtual void	OnFirmwareUpdateProgressStepPartialProgress (EFirmwareUpdateProgressStepType ProgressStepType, double ProgressPercentOfDone)=0
	Signal the progress of the current firmware update step. More...
Public Member Functions inherited from GENAPI_NAMESPACE::IDestructible
virtual	~IDestructible ()
	Default implementation of destructor. More...

Detailed Description

Represents a firmware update observer.

This interface is used by CFirmwareUpdater::ApplyUpdate().

Definition at line 60 of file FirmwareUpdateProgressObserver.h.

Member Function Documentation

OnFirmwareUpdateBegin()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateBegin ( const CFirmwareUpdateInfo &  FirmwareUpdateInfo, unsigned int  EstimatedDurationMs  )

pure virtual

Signal the start of a firmware update.

Parameters

[in]	FirmwareUpdateInfo	The firmware update info object representing a firmware update.
[in]	EstimatedDurationMs	The estimated time for the whole update to take. This is provided for informational purposes only.

Can throw C++ exceptions.

OnFirmwareUpdateEnd()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateEnd ( )

pure virtual

Signal the end of a firmware update.

Can throw C++ exceptions.

OnFirmwareUpdateError()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateError ( const GENICAM_NAMESPACE::GenericException &  TheError )

pure virtual

Signal that an error occurred during firmware update (between OnFirmwareUpdateBegin() and OnFirmwareUpdateEnd()).

Parameters

[in]

TheError

The exception that has been thrown while performing an update step. Caught unknown exception types are converted to a GenericException.

After this call the original exception caught is re-thrown

C++ exceptions thrown by this call are ignored.

OnFirmwareUpdateProgressStepBegin()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateProgressStepBegin ( EFirmwareUpdateProgressStepType  ProgressStepType, unsigned int  EstimatedDurationMs, const char *  Description  )

pure virtual

Signal the start of a single firmware update step.

Parameters

[in]	ProgressStepType	The type of the step.
[in]	EstimatedDurationMs	The estimated time for the step to take. This provided is for informational purposes only.

C++ exceptions thrown by this call are ignored to not interrupt the update process and eventually brick the updated device.

OnFirmwareUpdateProgressStepEnd()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateProgressStepEnd ( EFirmwareUpdateProgressStepType  ProgressStepType, unsigned int  EstimatedDurationMs  )

pure virtual

Signal the end of a single firmware update step.

Parameters

[in]	ProgressStepType	The type of the step. This is the same value as passed in OnFirmwareUpdateProgressStepBegin.
[in]	EstimatedDurationMs	The estimated time for the step to take. This provided is for informational purposes only. This is the same value as passed in OnFirmwareUpdateProgressStepBegin.

C++ exceptions thrown by this call are ignored to not interrupt the update process and eventually brick the updated device.

OnFirmwareUpdateProgressStepPartialProgress()

virtual void GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver::OnFirmwareUpdateProgressStepPartialProgress ( EFirmwareUpdateProgressStepType  ProgressStepType, double  ProgressPercentOfDone  )

pure virtual

Signal the progress of the current firmware update step.

Parameters

[in]	ProgressStepType	The type of the step. This is the same value as passed in OnFirmwareUpdateProgressStepBegin.
[in]	ProgressPercentOfDone	Progress of the sub step taking longer time to complete, e.g. file upload to the device, data range: 0.0 - 100.0.

This method is not called for all update steps.

C++ exceptions thrown by this call are ignored to not interrupt the update process and eventually brick the updated device.

---

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

• FirmwareUpdateProgressObserver.h