Tracking System

SWITCH TO MANUAL

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 database and 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 needto 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 willalso split the data into pages if the page is not zero. This will cache thedata 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 objectthat may be stored in the database and attempt to export it to a CSV file. Thiswill overwrite any existing file with the same name.
ExportToFile	Exports the tracking data to a JSON file. This will look at a particular objectthat may be stored in the database and attempt to export it to a JSON file.
ExportToJSON	Exports the tracking data to a JSON object. This will look at a particular objectthat may be stored in the database and attempt to export it to a JSON object.
ExportToString	Exports the tracking data to a string. This will look at a particular objectand attempt to export it to a JSON string.
Query	Queries the times of the object in the database. This will be in simulationseconds and returns all times of the data that is stored associated with anobject.
QueryString	Queries the data of the object in the database. This will return all the datawithin a range of time values stored within the database and will be able tooutput the data, in a JSON format, for the parameters that are passed into thefunction.
QueryTimes	Queries the times of the object in the database. This will be in simulationseconds and returns all times of the data that is stored associated with anobject.
QueryValues	Queries the data of the object in the database. This will return all the datafor a particular object and a particular parameter.
TrackObject	Starts tracking an object in the system. This will be used to storethe properties of the object in the database.
UntrackObject	Stops tracking an object in the system. This will remove the object fromthe database and stop storing its properties.

Inherited	Description
Destroy	Removes the current object from the simulation.