FirmwareUpdateProgressObserver.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_FIRMWAREUPDATEPROGRESSOBSERVER_H
#define GENFW_FIRMWAREUPDATEPROGRESSOBSERVER_H

#include <GenICamFwd.h>
#include <Base/GCException.h>
#include <FirmwareUpdate/FirmwareUpdateDll.h>
#include <FirmwareUpdate/FirmwareUpdateLinkage.h>
#include <FirmwareUpdate/FirmwareUpdateInfo.h>
#include <FirmwareUpdate/Destructible.h>

namespace GENAPI_NAMESPACE
{
    enum EFirmwareUpdateProgressStepType
    {
        ProgressStepType_CheckPreconditions,    
        ProgressStepType_AcquireUpdateData,     
        ProgressStepType_FeatureWrite,          
        ProgressStepType_FeatureExecute,        
        ProgressStepType_FeatureAssert,         
        ProgressStepType_FileUpload,            
        ProgressStepType_DeviceReset,           
        ProgressStepType_Invalid                
    };


    class GENFW_DECL_ABSTRACT IFirmwareUpdateProgressObserver : public IDestructible
    {
    public:
        virtual void OnFirmwareUpdateBegin(const CFirmwareUpdateInfo& FirmwareUpdateInfo, unsigned int EstimatedDurationMs) = 0;


        virtual void OnFirmwareUpdateProgressStepBegin(EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs, const char* Description) = 0;


        virtual void OnFirmwareUpdateProgressStepPartialProgress(EFirmwareUpdateProgressStepType ProgressStepType, double ProgressPercentOfDone) = 0;


        virtual void OnFirmwareUpdateProgressStepEnd(EFirmwareUpdateProgressStepType ProgressStepType, unsigned int EstimatedDurationMs) = 0;


        virtual void OnFirmwareUpdateEnd() = 0;


        virtual void OnFirmwareUpdateError(const GENICAM_NAMESPACE::GenericException& TheError) = 0;
    };
}

#endif // GENFW_FIRMWAREUPDATEPROGRESSOBSERVER_H