FirmwareUpdater.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2016-2017 by Basler AG
//  Project: GenApi
//  Author:  Andreas Gau
//
//  License: This file is published under the license of the EMVA GenICam Standard Group.
//  A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef GENFW_FIRMWAREUPDATER_H
#define GENFW_FIRMWAREUPDATER_H

#include <GenICamFwd.h>
#include <FirmwareUpdate/FirmwareUpdateDll.h>
#include <FirmwareUpdate/FirmwareUpdateLinkage.h>
#include <FirmwareUpdate/FirmwareUpdateInfoCollector.h>
#include <FirmwareUpdate/FirmwareUpdateProgressObserver.h>
#include <FirmwareUpdate/FirmwareUpdatableDevice.h>

namespace GENAPI_NAMESPACE
{
    class GENFW_DECL CFirmwareUpdater
    {
    public:
        CFirmwareUpdater();


        ~CFirmwareUpdater();


        void GetSignatureCheckInfo(const GENICAM_NAMESPACE::gcstring& Filename,
            size_t& OffsetPackageZipFile,
            size_t& SizePackageZipFile,
            size_t& OffsetSignatureFile,
            size_t& SizeSignatureFile
            ) const;


        void ReadFirmwareUpdateInfos(
            const GENICAM_NAMESPACE::gcstring& Filename,
            IFirmwareUpdateInfoCollector& FirmwareUpdateInfoCollector,
            const char* pPreferredLanguageCode = NULL) const;


        bool FirmwareUpdateMatchesDevice(
            INodeMap *pNodeMapOfOpenDevice,
            const CFirmwareUpdateInfo& FirmwareUpdateInfo) const;


        void ApplyUpdate(
            IFirmwareUpdatableDevice* pDeviceToUpdate,
            const CFirmwareUpdateInfo& FirmwareUpdateInfo,
            IFirmwareUpdateProgressObserver* pProgressObserver = NULL,
            const char* pPreferredLanguageCode = NULL);


        void VerifyGufFile(const GENICAM_NAMESPACE::gcstring& Filename);

    private:
        // Not copyable
        CFirmwareUpdater(const CFirmwareUpdater&);
        CFirmwareUpdater& operator =(const CFirmwareUpdater&);

        // Hide the details:
        class CFirmwareUpdaterImpl;
        CFirmwareUpdaterImpl* m_pImpl;
    };
}

#endif // GENFW_FIRMWAREUPDATER_H