Class CollectorBase
Inheritance
CollectorBase
Syntax
[Serializable]
public abstract class CollectorBase
Constructors
CollectorBase()
Declaration
protected CollectorBase()
Fields
category
Category for simulation profiler collector. Default is set to Logic.
Declaration
[SerializeField]
[HideInInspector]
public Category category
Field Value
CollectorConsumer
Consumer delegate to consume the collector profiler report. Invoked when the collector is ready for dispatch.
Declaration
public CollectorBase.ConsumeCollectorReport CollectorConsumer
Field Value
m_Enabled
Field indicating if the collector is enabled.
Declaration
[SerializeField]
[HideInInspector]
public bool m_Enabled
Field Value
name
Name of the collector. Default is set to the name of the type.
Declaration
[SerializeField]
public string name
Field Value
pathOnFileSystem
Declaration
[HideInInspector]
public string pathOnFileSystem
Field Value
period
Period at which the collector dispatch needs to be invoked.
Declaration
Field Value
simulationElapsedTime
Declaration
[HideInInspector]
public float simulationElapsedTime
Field Value
Properties
defaultDispatcherEnabled
Returns if the default collector dispatcher is enabled.
Declaration
public bool defaultDispatcherEnabled { get; protected set; }
Property Value
Methods
AddEvent(EventBase)
Add Continuous event to the collector for profiling.
Declaration
public void AddEvent(EventBase e)
Parameters
DispatchCollector(ProfilerReport)
Dispatch collector at an interval. Override this to dispatch the
results to any other location other than local file system.
Declaration
public virtual void DispatchCollector(ProfilerReport report)
Parameters
GetEvents()
Get all the events associated with the collector.
Declaration
public List<EventBase> GetEvents()
Returns
Initialize()
Initialize your collector settings here.
Declaration
public virtual void Initialize()
PopulateEvents()
Declaration
public abstract void PopulateEvents()