All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
FirmwareUpdater.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_FIRMWAREUPDATER_H
28 #define GENFW_FIRMWAREUPDATER_H
29 
30 #include <GenICamFwd.h>
36 
37 namespace GENAPI_NAMESPACE
38 {
45  {
46  public:
53 
54 
61 
62 
78  void GetSignatureCheckInfo(const GENICAM_NAMESPACE::gcstring& Filename,
79  size_t& OffsetPackageZipFile,
80  size_t& SizePackageZipFile,
81  size_t& OffsetSignatureFile,
82  size_t& SizeSignatureFile
83  ) const;
84 
85 
98  void ReadFirmwareUpdateInfos(
99  const GENICAM_NAMESPACE::gcstring& Filename,
100  IFirmwareUpdateInfoCollector& FirmwareUpdateInfoCollector,
101  const char* pPreferredLanguageCode = NULL) const;
102 
103 
112  bool FirmwareUpdateMatchesDevice(
113  INodeMap *pNodeMapOfOpenDevice,
114  const CFirmwareUpdateInfo& FirmwareUpdateInfo) const;
115 
116 
134  void ApplyUpdate(
135  IFirmwareUpdatableDevice* pDeviceToUpdate,
136  const CFirmwareUpdateInfo& FirmwareUpdateInfo,
137  IFirmwareUpdateProgressObserver* pProgressObserver = NULL,
138  const char* pPreferredLanguageCode = NULL);
139 
140 
152  void VerifyGufFile(const GENICAM_NAMESPACE::gcstring& Filename);
153 
154  private:
155  // Not copyable
158 
159  // Hide the details:
160  class CFirmwareUpdaterImpl;
161  CFirmwareUpdaterImpl* m_pImpl;
162  };
163 }
164 
165 #endif // GENFW_FIRMWAREUPDATER_H
GENAPI_NAMESPACE
Lexical analyzer for CIntSwissKnife.
Definition: Destructible.h:30
GENAPI_NAMESPACE::CFirmwareUpdater::m_pImpl
CFirmwareUpdaterImpl * m_pImpl
Definition: FirmwareUpdater.h:160
FirmwareUpdateDll.h
Defines to be used for FirmwareUpdate library.
GENICAM_NAMESPACE::gcstring
A string class which is a clone of std::string.
Definition: GCString.h:52
FirmwareUpdateProgressObserver.h
Declaration of IFirmwareUpdateProgressObserver and EFirmwareUpdateProgressStepType.
FirmwareUpdatableDevice.h
Declaration of IFirmwareUpdatableDevice.
GenICamFwd.h
Forward declarations for GenICam types.
GENAPI_NAMESPACE::INodeMap
GENICAM_INTERFACE INodeMap
Interface to access the node map.
Definition: INode.h:52
FirmwareUpdateInfoCollector.h
Declaration of IFirmwareUpdateInfoCollector.
GENAPI_NAMESPACE::CFirmwareUpdater
The CFirmwareUpdater is responsible for running firmware updates.
Definition: FirmwareUpdater.h:44
GENAPI_NAMESPACE::CFirmwareUpdateInfo
Identifies a single firmware update and holds information about the firmware update.
Definition: FirmwareUpdateInfo.h:72
GENFW_DECL
#define GENFW_DECL
Definition: FirmwareUpdateDll.h:52
GENAPI_NAMESPACE::IFirmwareUpdateInfoCollector
Represents a sink collecting all firmware updates contained in a guf file.
Definition: FirmwareUpdateInfoCollector.h:44
GENAPI_NAMESPACE::IFirmwareUpdatableDevice
Represents a device that can be updated.
Definition: FirmwareUpdatableDevice.h:41
GENAPI_NAMESPACE::operator=
virtual IBoolean & operator=(bool Value)
Set node value.
Definition: IBoolean.h:64
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