All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
FirmwareUpdateProgressObserver.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2016-2017 by Basler AG
3 // Project: GenApi
4 // Author: Andreas Gau
5 //
6 // License: This file is published under the license of the EMVA GenICam Standard Group.
7 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
8 // If for some reason you are missing this file please contact the EMVA or visit the website
9 // (http://www.genicam.org) for a full copy.
10 //
11 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
12 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
13 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
14 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
15 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
16 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
17 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
18 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
19 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
20 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
21 // POSSIBILITY OF SUCH DAMAGE.
22 //-----------------------------------------------------------------------------
27 #ifndef GENFW_FIRMWAREUPDATEPROGRESSOBSERVER_H
28 #define GENFW_FIRMWAREUPDATEPROGRESSOBSERVER_H
29 
30 #include <GenICamFwd.h>
31 #include <Base/GCException.h>
36 
37 namespace GENAPI_NAMESPACE
38 {
44  {
53  };
54 
55 
60  class GENFW_DECL_ABSTRACT IFirmwareUpdateProgressObserver : public IDestructible
61  {
62  public:
70  virtual void OnFirmwareUpdateBegin(const CFirmwareUpdateInfo& FirmwareUpdateInfo, unsigned int EstimatedDurationMs) = 0;
71 
72 
80  virtual void OnFirmwareUpdateProgressStepBegin(EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs, const char* Description) = 0;
81 
82 
92  virtual void OnFirmwareUpdateProgressStepPartialProgress(EFirmwareUpdateProgressStepType ProgressStepType, double ProgressPercentOfDone) = 0;
93 
94 
103  virtual void OnFirmwareUpdateProgressStepEnd(EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs) = 0;
104 
105 
111  virtual void OnFirmwareUpdateEnd() = 0;
112 
113 
122  virtual void OnFirmwareUpdateError(const GENICAM_NAMESPACE::GenericException& TheError) = 0;
123  };
124 }
125 
126 #endif // GENFW_FIRMWAREUPDATEPROGRESSOBSERVER_H
GENAPI_NAMESPACE
Lexical analyzer for CIntSwissKnife.
Definition: Destructible.h:30
FirmwareUpdateDll.h
Defines to be used for FirmwareUpdate library.
Destructible.h
Declaration of of IDestructible base class.
GENAPI_NAMESPACE::ProgressStepType_Invalid
@ ProgressStepType_Invalid
Invalid value.
Definition: FirmwareUpdateProgressObserver.h:52
GenICamFwd.h
Forward declarations for GenICam types.
GENAPI_NAMESPACE::ProgressStepType_FeatureExecute
@ ProgressStepType_FeatureExecute
Executes the given GenICam feature.
Definition: FirmwareUpdateProgressObserver.h:48
GENAPI_NAMESPACE::ProgressStepType_FileUpload
@ ProgressStepType_FileUpload
Uploads a file to the device using the GenICam FileAccess feature.
Definition: FirmwareUpdateProgressObserver.h:50
GENAPI_NAMESPACE::ProgressStepType_FeatureAssert
@ ProgressStepType_FeatureAssert
Asserts a GenICam feature's value matches a regular expression.
Definition: FirmwareUpdateProgressObserver.h:49
GENAPI_NAMESPACE::EFirmwareUpdateProgressStepType
EFirmwareUpdateProgressStepType
The steps that can be performed in a firmware update.
Definition: FirmwareUpdateProgressObserver.h:43
GENAPI_NAMESPACE::CFirmwareUpdateInfo
Identifies a single firmware update and holds information about the firmware update.
Definition: FirmwareUpdateInfo.h:72
GENAPI_NAMESPACE::ProgressStepType_CheckPreconditions
@ ProgressStepType_CheckPreconditions
Compares all conditions of the update with the device.
Definition: FirmwareUpdateProgressObserver.h:45
GENICAM_NAMESPACE::GenericException
GenICam's exception class.
Definition: GCException.h:63
GENAPI_NAMESPACE::ProgressStepType_AcquireUpdateData
@ ProgressStepType_AcquireUpdateData
Checks that everything required for the update is available.
Definition: FirmwareUpdateProgressObserver.h:46
GENAPI_NAMESPACE::ProgressStepType_DeviceReset
@ ProgressStepType_DeviceReset
A device reset is executed.
Definition: FirmwareUpdateProgressObserver.h:51
GENAPI_NAMESPACE::IDestructible
Destructible object to ensure destruction via interface.
Definition: Destructible.h:37
GCException.h
FirmwareUpdateInfo.h
Declaration of CFirmwareUpdateInfo.
GENAPI_NAMESPACE::ProgressStepType_FeatureWrite
@ ProgressStepType_FeatureWrite
Writes the value to a GenICam feature of the device.
Definition: FirmwareUpdateProgressObserver.h:47
FirmwareUpdateLinkage.h
helpers for pragma linkage
GENAPI_NAMESPACE::IFirmwareUpdateProgressObserver
Represents a firmware update observer.
Definition: FirmwareUpdateProgressObserver.h:60


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:11