YiVersion.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_VERSION_H_
#define _YI_VERSION_H_

#include "framework/YiVersionData.h"
#include "utility/YiString.h"

class CYIVersion
{
public:
    CYIVersion();

    CYIVersion(uint32_t uMajorVersion, uint32_t uMinorVersion, uint32_t uPatchVersion, CYIString hotfixVersion = "", CYIString versionControlID = "", CYIString buildDate = "");

    uint32_t GetMajorVersion() const;

    uint32_t GetMinorVersion() const;

    uint32_t GetPatchVersion() const;

    CYIString GetHotfixVersion() const;

    CYIString GetVersionString() const;

    bool HasHotfixVersion() const;

    const CYIString &GetVersionControlID() const;

    const CYIString &GetBuildDate() const;

    bool operator==(const CYIVersion &other) const;
    bool operator!=(const CYIVersion &other) const;
    bool operator<(const CYIVersion &other) const;
    bool operator>(const CYIVersion &other) const;
    bool operator<=(const CYIVersion &other) const;
    bool operator>=(const CYIVersion &other) const;

    static const CYIVersion &GetEngineVersion();

    /*
     \details Returns a CYIVersion object that is converted from the supplied \a versionString.
     */
    static CYIVersion FromVersionString(const CYIString &versionString);

private:
    uint32_t m_uMajorVersion;
    uint32_t m_uMinorVersion;
    uint32_t m_uPatchVersion;
    CYIString m_HotfixVersion;
    CYIString m_VersionControlID;
    CYIString m_BuildDate;
};

#endif // _YI_VERSION_H_