The statistics interface. More...

#include "murl_core_i_statistics.h"

Inherited by Murl::Core::Statistics.

Public Member Functions
virtual StatisticsItem	GetTotal () const =0
	Get the total time used for processing the last frame. More...

virtual const StatisticsItem &	GetProcessGraphLogic () const =0
	Get the time used for processing ProcessGraphLogic during the last frame. More...

virtual const StatisticsItem &	GetFinishGraphLogic () const =0
	Get the time used for processing FinishGraphLogic during the last frame. More...

virtual const StatisticsItem &	GetProcessGraphInput () const =0
	Get the time used for processing ProcessGraphInput during the last frame. More...

virtual const StatisticsItem &	GetFinishGraphInput () const =0
	Get the time used for processing FinishGraphInput during the last frame. More...

virtual const StatisticsItem &	GetProcessLogicTick () const =0
	Get the time used for processing ProcessLogicTick during the last frame. More...

virtual const StatisticsItem &	GetFinishLogicTick () const =0
	Get the time used for processing FinishLogicTick during the last frame. More...

virtual const StatisticsItem &	GetProcessLogicFrame () const =0
	Get the time used for processing ProcessLogicFrame during the last frame. More...

virtual const StatisticsItem &	GetFinishLogicFrame () const =0
	Get the time used for processing FinishLogicFrame during the last frame. More...

virtual const StatisticsItem &	GetProcessGraphOutput () const =0
	Get the time used for processing GraphOutput during the last frame. More...

virtual const StatisticsItem &	GetFinishGraphOutput () const =0
	Get the time used for processing FinishGraphOutput during the last frame. More...

virtual const StatisticsItem &	GetSimulator () const =0
	Get the time used for processing the simulator during the last frame. More...

virtual const StatisticsItem &	GetRenderer () const =0
	Get the time used for processing the Video- and AudioRenderer during the last frame. More...

virtual String	GetMessage () const =0
	Get the system debug info message which can be configured by the Murl::IAppConfiguration::SetSystemDebugInfoItems method. More...

virtual Bool	TriggerReport (IEnums::StatisticReportType type, SInt32 maxDepth=1) const =0
	Trigger generating a statistics report. More...

virtual Bool	IsReportReady () const =0
	Check if a requested statistics report is ready. More...

virtual String	GetReport () const =0
	Get the generated statistics report if it is ready. More...

virtual String	GenerateEngineTransitionTimes ()=0
	Generate the loading/init/suspend/resume time report. More...

Detailed Description

The statistics interface.

Member Function Documentation

◆ GetTotal()

virtual StatisticsItem Murl::Core::IStatistics::GetTotal ( ) const

pure virtual

Get the total time used for processing the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetProcessGraphLogic()

virtual const StatisticsItem& Murl::Core::IStatistics::GetProcessGraphLogic ( ) const

pure virtual

Get the time used for processing ProcessGraphLogic during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetFinishGraphLogic()

virtual const StatisticsItem& Murl::Core::IStatistics::GetFinishGraphLogic ( ) const

pure virtual

Get the time used for processing FinishGraphLogic during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetProcessGraphInput()

virtual const StatisticsItem& Murl::Core::IStatistics::GetProcessGraphInput ( ) const

pure virtual

Get the time used for processing ProcessGraphInput during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetFinishGraphInput()

virtual const StatisticsItem& Murl::Core::IStatistics::GetFinishGraphInput ( ) const

pure virtual

Get the time used for processing FinishGraphInput during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetProcessLogicTick()

virtual const StatisticsItem& Murl::Core::IStatistics::GetProcessLogicTick ( ) const

pure virtual

Get the time used for processing ProcessLogicTick during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetFinishLogicTick()

virtual const StatisticsItem& Murl::Core::IStatistics::GetFinishLogicTick ( ) const

pure virtual

Get the time used for processing FinishLogicTick during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetProcessLogicFrame()

virtual const StatisticsItem& Murl::Core::IStatistics::GetProcessLogicFrame ( ) const

pure virtual

Get the time used for processing ProcessLogicFrame during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetFinishLogicFrame()

virtual const StatisticsItem& Murl::Core::IStatistics::GetFinishLogicFrame ( ) const

pure virtual

Get the time used for processing FinishLogicFrame during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetProcessGraphOutput()

virtual const StatisticsItem& Murl::Core::IStatistics::GetProcessGraphOutput ( ) const

pure virtual

Get the time used for processing GraphOutput during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetFinishGraphOutput()

virtual const StatisticsItem& Murl::Core::IStatistics::GetFinishGraphOutput ( ) const

pure virtual

Get the time used for processing FinishGraphOutput during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetSimulator()

virtual const StatisticsItem& Murl::Core::IStatistics::GetSimulator ( ) const

pure virtual

Get the time used for processing the simulator during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetRenderer()

virtual const StatisticsItem& Murl::Core::IStatistics::GetRenderer ( ) const

pure virtual

Get the time used for processing the Video- and AudioRenderer during the last frame.

Returns: The time value in µsec as StatisticsItem.

◆ GetMessage()

virtual String Murl::Core::IStatistics::GetMessage ( ) const

pure virtual

Get the system debug info message which can be configured by the Murl::IAppConfiguration::SetSystemDebugInfoItems method.

Returns: The system debug info message as String.

◆ TriggerReport()

virtual Bool Murl::Core::IStatistics::TriggerReport	(	IEnums::StatisticReportType	type,
		SInt32	maxDepth = `1`
	)		const

pure virtual

Trigger generating a statistics report.

Returns: true if successful.

◆ IsReportReady()

virtual Bool Murl::Core::IStatistics::IsReportReady ( ) const

pure virtual

Check if a requested statistics report is ready.

A report becomes ready some time after it was requested via a call to TriggerReport().

Returns: true if ready.

◆ GetReport()

virtual String Murl::Core::IStatistics::GetReport ( ) const

pure virtual

Get the generated statistics report if it is ready.

To obtain a valid report, it must first be requested via a call to TriggerReport(), and as soon as IsReportReady() returns true, this method will return the actual report. A requested report can only be retrieved once; after the call to this method, the report is discarded internally.

Returns: The generated report, or an empty string if none is ready.

◆ GenerateEngineTransitionTimes()

virtual String Murl::Core::IStatistics::GenerateEngineTransitionTimes ( )

pure virtual

Generate the loading/init/suspend/resume time report.

Returns: The generated transition time(s) as string

The documentation for this interface was generated from the following file:

murl_core_i_statistics.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetTotal()

◆ GetProcessGraphLogic()

◆ GetFinishGraphLogic()

◆ GetProcessGraphInput()

◆ GetFinishGraphInput()

◆ GetProcessLogicTick()

◆ GetFinishLogicTick()

◆ GetProcessLogicFrame()

◆ GetFinishLogicFrame()

◆ GetProcessGraphOutput()

◆ GetFinishGraphOutput()

◆ GetSimulator()

◆ GetRenderer()

◆ GetMessage()

◆ TriggerReport()

◆ IsReportReady()

◆ GetReport()

◆ GenerateEngineTransitionTimes()