class MAGES::AnalyticsModule¶

Overview¶

The analytics module base class. More…

class AnalyticsModule: public MAGES::HubModule
{
public:
    // properties

    string ExportPath;

    // methods

    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;
};

// direct descendants

class MAGESAnalytics;
class StubAnalytics;

Inherited Members¶

public:
    // methods

    virtual abstract void Startup() = 0;
    virtual abstract void Shutdown() = 0;

Detailed Documentation¶

The analytics module base class.

Properties¶

string ExportPath

Gets or sets the export path of analytics data.

Methods¶

virtual abstract void InitializeTimer() = 0

Intializes the analytics timer.

virtual abstract void InvalidateTimer() = 0

Invalidates the analytics timer and resets it.

virtual abstract double GetTimeSinceStartUp() = 0

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 abstract TQuery AddQuery< TQuery >(string name) = 0

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 abstract TQuery GetQuery< TQuery >(string name) = 0

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 abstract void RemoveQuery< TQuery >(string name) = 0

Removes a stored query under the given name.

Parameters:

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

virtual abstract TEvent AddEvent< TEvent >(string name) = 0

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 abstract TEvent GetEvent< TEvent >(string name) = 0

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 abstract void RemoveEvent< TEvent >(string name) = 0

Removes a stored event under the given name.

Parameters:

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

virtual abstract void ExportAll() = 0

Exports all analytics data.

virtual abstract void ExportQueries(string tag = "") = 0

Export all queries.

Parameters:

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

virtual abstract void ExportEvents(string tag = "") = 0

Exports all events.

Parameters:

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