querystatistics.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/querysystem/iquery.h"
#include "gwnavruntime/containers/kyarray.h"
#include "gwnavruntime/base/memory.h"

namespace Kaim
{

class Database;
class StringBuffer;

class PerformQueryStatCounter
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
public:
    void Clear()
    {
        for (KyUInt32 i = 0; i < QueryType_FirstCustom; ++i)
            m_perQueryCounter[i] = 0;
    }

    void Increment(QueryType queryType) { ++m_perQueryCounter[queryType]; }

    KyUInt32 GetCount(QueryType queryType) const { return m_perQueryCounter[queryType]; }

public:
    KyUInt32 m_perQueryCounter[QueryType_FirstCustom];
};

enum QueryStatReportType
{
    QueryStatReport_RelevantOnly, 
    QueryStatReport_All, 
};

#if defined(KY_CONFIG_DEBUG_OR_DEV)

class PerformQueryStatistics
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
public:

    void ResetPerformQueryCounter();

    void Report(StringBuffer* report, QueryStatReportType reportType = QueryStatReport_RelevantOnly) const;

public: // internal
    void Initialize(); 

    static const char* GetPerformQueryStatName(PerformQueryStat queryStat);

    void IncrementPerformQueryStat(PerformQueryStat stat, QueryType queryType) { if (stat < PerformQueryStat_Count) m_queryStatCounter[stat].Increment(queryType); }

    KyUInt32 GetPerformQueryStatCount(PerformQueryStat stat, QueryType queryType) { return m_queryStatCounter[stat].GetCount(queryType); }

    KyUInt32& GetPerformQueryCount(QueryType queryType) { return m_perQueryCounter[queryType]; }

public:
    KyArray<KyUInt32> m_perQueryCounter; 
    KyArray<PerformQueryStatCounter> m_queryStatCounter; 
};

class ScopedPerformedQueryCounter
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
    KY_CLASS_WITHOUT_COPY(ScopedPerformedQueryCounter)
public:
    ScopedPerformedQueryCounter(QueryType queryType, Database* database, PerformQueryStat queryStat);

    ~ScopedPerformedQueryCounter() { ++m_counter;  }

private:
    KyUInt32& m_counter;
};

#else // KY_CONFIG_RELEASE is defined

class PerformQueryStatistics
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
public:
    void ResetPerformQueryCounter() {}
    void Report(StringBuffer*, QueryStatReportType reportType = QueryStatReport_RelevantOnly) const { KY_UNUSED(reportType); }
    void Initialize() {}
};

class ScopedPerformedQueryCounter
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_WorldFwk)
public:
    ScopedPerformedQueryCounter(QueryType, Database*, PerformQueryStat) {}
    ~ScopedPerformedQueryCounter() {}
};
#endif

}