FirmwareUpdateInfo.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_FIRMWAREUPDATEINFO_H
#define GENFW_FIRMWAREUPDATEINFO_H

#include <GenICamFwd.h>
#include <Base/GCString.h>
#include <FirmwareUpdate/FirmwareUpdateDll.h>
#include <FirmwareUpdate/FirmwareUpdateLinkage.h>



namespace GENAPI_NAMESPACE
{
    // Note: Using static const char* here to allow delay loading the library.
    static const char* const FirmwareUpdateInfoKey_Description = "Description"; 
    static const char* const FirmwareUpdateInfoKey_Version = "Version";  
    static const char* const FirmwareUpdateInfoKey_VersionStyle = "VersionStyle";  
    static const char* const FirmwareUpdateInfoValue_VersionStyle_Dotted = "dotted";  
    static const char* const FirmwareUpdateInfoValue_VersionStyle_SemVer = "semver";  
    static const char* const FirmwareUpdateInfoKey_VersionExtractionPattern = "VersionExtractionPattern"; 
    static const char* const FirmwareUpdateInfoKey_ReleaseNotes = "ReleaseNotes"; 
    static const char* const FirmwareUpdateInfoKey_ReleaseNotesURL = "ReleaseNotesURL"; 
    static const char* const FirmwareUpdateInfoKey_UserSetPersistence = "UserSetPersistence";  
    static const char* const FirmwareUpdateInfoKey_SequencerSetPersistence = "SequencerSetPersistence"; 
    static const char* const FirmwareUpdateInfoKey_PersistenceSupport_None = "none"; 
    static const char* const FirmwareUpdateInfoKey_PersistenceSupport_Full = "full"; 




    class GENFW_DECL CFirmwareUpdateInfo
    {
    public:
        CFirmwareUpdateInfo();


        CFirmwareUpdateInfo(const CFirmwareUpdateInfo& Rhs);


        CFirmwareUpdateInfo& operator=(const CFirmwareUpdateInfo& Rhs);


        ~CFirmwareUpdateInfo();


        bool operator==(const CFirmwareUpdateInfo& Rhs) const;


        bool IsValid() const;


        const char* GetUpdateFilename() const;


        const char* GetInfo(const char* InfoKey) const;


        const char* GetInfo(const char* InfoKey, const char* pDefaultValueIfNotAvailable) const;


        size_t GetCountOfInfos() const; //can be 0


        const char* GetInfoKey(size_t Index) const;


        const char* GetInfo(size_t Index) const;


        const char* GetInfoLanguageCode(const char* InfoKey) const;


        GENICAM_NAMESPACE::gcstring ExtractVersionFromDeviceFirmwareVersion(const GENICAM_NAMESPACE::gcstring& DeviceFirmwareVersionFromDevice) const;

    protected:
        // Hide the details:
        class CFirmwareUpdateInfoImpl;
        CFirmwareUpdateInfoImpl* m_pImpl;
    };
}

#endif // GENFW_FIRMWAREUPDATEINFO_H