class MAGES::StubAnalytics¶

Overview¶

Stub class for the analytics module. More…

class StubAnalytics: public MAGES::AnalyticsModule
{
public:
    // methods

    virtual override void Startup();
    virtual override void Shutdown();
    virtual override void InitializeTimer();
    virtual override void InvalidateTimer();
    virtual override double GetTimeSinceStartUp();
    virtual override TQuery AddQuery< TQuery >(string name);
    virtual override TQuery GetQuery< TQuery >(string name);
    virtual override void RemoveQuery< TQuery >(string name);
    virtual override TEvent AddEvent< TEvent >(string name);
    virtual override TEvent GetEvent< TEvent >(string name);
    virtual override void RemoveEvent< TEvent >(string name);
    virtual override void ExportAll();
    virtual override void ExportQueries(string tag = "");
    virtual override void ExportEvents(string tag = "");
};

Inherited Members¶

public:
    // properties

    string ExportPath;

    // methods

    virtual abstract void Startup() = 0;
    virtual abstract void Shutdown() = 0;
    virtual abstract void InitializeTimer() = 0;
    virtual abstract void InvalidateTimer() = 0;
    virtual abstract double GetTimeSinceStartUp() = 0;
    virtual abstract TQuery AddQuery< TQuery >(string name) = 0;
    virtual abstract TQuery GetQuery< TQuery >(string name) = 0;
    virtual abstract void RemoveQuery< TQuery >(string name) = 0;
    virtual abstract TEvent AddEvent< TEvent >(string name) = 0;
    virtual abstract TEvent GetEvent< TEvent >(string name) = 0;
    virtual abstract void RemoveEvent< TEvent >(string name) = 0;
    virtual abstract void ExportAll() = 0;
    virtual abstract void ExportQueries(string tag = "") = 0;
    virtual abstract void ExportEvents(string tag = "") = 0;

Detailed Documentation¶

Stub class for the analytics module.

Methods¶

virtual override void Startup()

Startup analytics (stub).

virtual override void Shutdown()

Shutdown analytics (stub).

virtual override void InitializeTimer()

Intializes the analytics timer.

virtual override void InvalidateTimer()

Invalidates the analytics timer and resets it.

virtual override double GetTimeSinceStartUp()

Gets the time since the last valid start up of the analytics timer in seconds.

Returns:

The time since the last valid start up of the analytics timer in seconds.

virtual override TQuery AddQuery< TQuery >(string name)

Creates a new query and stores it under the given name.

Parameters:

TQuery	The type of the new query.
name	The name of the query.

Returns:

The newly created query.

virtual override TQuery GetQuery< TQuery >(string name)

Retrieves a stored query under the given name.

Parameters:

TQuery	The type of the requested query.
name	The name of the requested query.

Returns:

The requested query.

virtual override void RemoveQuery< TQuery >(string name)

Removes a stored query under the given name.

Parameters:

TQuery	The type of the requested query.
name	The name of the query.

virtual override TEvent AddEvent< TEvent >(string name)

Creates a new event and stores it under the given name.

Parameters:

TEvent	The type of the requested event.
name	The name of the event.

Returns:

The newly created event.

virtual override TEvent GetEvent< TEvent >(string name)

Retrieves a stored event under the given name.

Parameters:

TEvent	The type of the requested event.
name	The name of the requested event.

Returns:

The requested event.

virtual override void RemoveEvent< TEvent >(string name)

Removes a stored event under the given name.

Parameters:

TEvent	The type of the requested query.
name	The name of the query.

virtual override void ExportAll()

Exports all analytics data.

virtual override void ExportQueries(string tag = "")

Export all queries.

Parameters:

tag	The queries with this tag will be exported. Everything is exported if empty.

virtual override void ExportEvents(string tag = "")

Exports all events.

Parameters:

tag	The events with this tag will be exported. Everything is exported if empty.