Class PerfStatsManager

Inheritance
object
PerfStatsManager
Inherited Members
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Core.dll
Syntax
public class PerfStatsManager

Fields

DEFAULT_ERROR_SAMPLE_VALUE

Declaration
public double DEFAULT_ERROR_SAMPLE_VALUE
Field Value
Type Description
double

realTimeSinceStartUp

Declaration
public float realTimeSinceStartUp
Field Value
Type Description
float

Properties

Instance

PerfStatsManager singleton instance to that can enable Start/Stop invoking the collectors.

Declaration
public static PerfStatsManager Instance { get; }
Property Value
Type Description
PerfStatsManager

Methods

BeginSample(string, Type)

Begin sample for the provided event.

Declaration
public void BeginSample(string eventName, Type associatedCollectorType)
Parameters
Type Name Description
string eventName
Type associatedCollectorType

DispatchCollectors(bool)

Invoke this function to flush all the events on all the collectors. This will invoke dispatcher on all the collectors. This call can be slow depending upon the dispatcher implementation.

Declaration
public void DispatchCollectors(bool shuttingDown = false)
Parameters
Type Name Description
bool shuttingDown

EndSample(string, Type)

End Sample for the provided event.

Declaration
public void EndSample(string eventName, Type associatedCollectorType)
Parameters
Type Name Description
string eventName
Type associatedCollectorType

SetGlobalDispatchers(List<IGlobalProfilerDataDispatcher>)

Declaration
public void SetGlobalDispatchers(List<IGlobalProfilerDataDispatcher> dispatchers)
Parameters
Type Name Description
List<IGlobalProfilerDataDispatcher> dispatchers

StartProfiling(List<CollectorBase>)

Invoke this method to start profiling by invoking/activating collectors.

Declaration
public void StartProfiling(List<CollectorBase> collectors)
Parameters
Type Name Description
List<CollectorBase> collectors

StopProfiling()

Inovke this method to stop profiling.

Declaration
public void StopProfiling()

TrackAPIUsage(string, Type)

Track API usage for the provided function.

Declaration
public void TrackAPIUsage(string functionName, Type associatedColletorType)
Parameters
Type Name Description
string functionName
Type associatedColletorType