Tracking System

Class in Zendir.Universe | Inherits from UniverseSystem

Declaration

class TrackingSystem;

Description

The tracking system is able to keep track of data and objects over the lifetime of the simulation and can store data into databases associated with this particular system.

Properties

Declared	Description
DatabasePath	The full path to the database that the tracking system will use to store data. This should be a SQLite databaseand be a new database.
Interval	[s] The interval at which the tracking system will update the data.
IsConnected	A flag that determines whether the system is connected to the database.
IsTicked	A flag that determines whether the system has done the first frame, as this will need to be skipped.

Inherited	Description
IsEnabled	Is true if the object is currently enabled.
Name	The display name or tag of this object.

Methods

Declared	Description
ExportToAPI	This function will export the data of the object to a JSON format. This will also split the data into pages ifthe page is not zero. This will cache the data for future use, so that the data can be fetched in batches.
ExportToCSV	Exports the tracking data to a CSV file. This will look at a particular object that may be stored in the databaseand attempt to export it to a CSV file. This will overwrite any existing file with the same name.
ExportToFile	Exports the tracking data to a JSON file. This will look at a particular object that may be stored in thedatabase and attempt to export it to a JSON file.
ExportToJSON	Exports the tracking data to a JSON object. This will look at a particular object that may be stored in thedatabase and attempt to export it to a JSON object.
ExportToString	Exports the tracking data to a string. This will look at a particular object and attempt to export it to a JSONstring.
Query	Queries the data of the object in the database. This will return all the data within a range of time valuesstored within the database and will be able to output the data, in a JSON format, for the parameters that arepassed into the function.
QueryString	Queries the data of the object in the database. This will return all the data within a range of time valuesstored within the database and will be able to output the data, in a JSON format, for the parameters that arepassed into the function.
QueryTimes	Queries the times of the object in the database. This will be in simulation seconds and returns all times of thedata that is stored associated with an object.
QueryValues	Queries the data of the object in the database. This will return all the data for a particular object and aparticular parameter.
TrackObject	Starts tracking an object in the system. This will be used to store the properties of the object in the database.
UntrackObject	Stops tracking an object in the system. This will remove the object from the database and stop storing itsproperties.