Abstract base class for all field-based metrics; Create a new FieldMetric recorder class by inheriting from this More...

Inheritance diagram for Abacus.FieldMetric< T >:

Public Member Functions
override T	GetValue ()
	Retrieve the current value from the property More...

Public Member Functions inherited from Abacus.Internal.Metric< T >
void	AttachVariable (Component component, string variableName)
	Attach a variable to the metric to be recorded More...

object	Dump ()
	Returns the metric's data as an object to be serialized More...

string	GetVariableName ()
	The name of the variable that this Metric records More...

Type	GetValueType ()
	The type that this Metric records More...

T	GetLastRecordedValue ()
	The last value recorded by this metric More...

void	Record ()
	Records the current value of the attached variable More...

void	SetSource (Component component)
	Sets the component that the metric retrieves a field or property from More...

void	SetTimeStep (float timeStep)
	Sets the time step for the recorder More...

void	Enable ()
	Enables the metric recorder More...

void	Disable ()
	Disables the metric recorder More...

Public Attributes
override bool	RetrievedMember => _fieldInfo != null

Public Attributes inherited from Abacus.Internal.Metric< T >
float	TimeStep => _timeStep
	The time step duration of the metric recorder More...

bool	IsEnabled => _isEnabled
	Whether the metric recorder is enabled More...

Additional Inherited Members
Protected Attributes inherited from Abacus.Internal.Metric< T >
bool	_recordOnStart = true

float	_timeStep = 1f

bool	_isEnabled = false

GameObject	recordGameObject

Component	recordFrom

int	recordFromIndex

string	recordName

int	recordNameIndex

Type	componentType

float	startTime

T	_lastRecordedValue

T	_previousValue

Properties inherited from Abacus.Internal.Metric< T >
abstract bool	RetrievedMember `[get]`
	Whether the metric recorder has retrieved the field/property it will record the value of More...

List< DataPoint< T > >	History = new List<DataPoint<T>>() `[get]`
	The history of recorded values for this metric More...

Properties inherited from Abacus.Internal.IRecordable
float	TimeStep `[get]`

bool	IsEnabled `[get]`

Detailed Description

Abstract base class for all field-based metrics; Create a new FieldMetric recorder class by inheriting from this

Template Parameters

T	The data type for the field metric to hold

Member Function Documentation

override T Abacus.FieldMetric< T >.GetValue ( )

virtual

Retrieve the current value from the property

Uses reflection! Call only as necessary!

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