Data Storage Message Writer

SWITCH TO MANUAL

Class in Zendir.Classes | Inherits from UniverseBehaviour

Declaration

class DataStorageMessageWriter;

---

Description

The message logger model is able to log registered messages to the partitioned data storage system. These messages can be retrieved at a later time or can be exported as a CSV file.

---

Properties

Declared	Description
In_EpochMsg	An optional epoch message that can be used to store the epoch data withinthe data.
Key	The key to write the data to within the model. By default, it is the basickey that is used to store the data within the system.
NextWriteTime	The next write time to copy the data into the storage system. This willbe updated at each update frame and will be used to determine when the datashould be copied.
NumSaved	The number of saved message pointers that have been stored in the system.
WriteInterval	The interval to write and copy the data into the partitioned storagesystem between writes.

Inherited	Description
IsEnabled	Is true if the object is currently enabled.
Name	The display name or tag of this object.
Parent	The currently attached parent object (if any).

---

Methods

Declared	Description
DeleteAll	Deletes all data and messages from being tracked by the system. This willnot delete the messages, but rather remove the connections with the messagesfrom the cache and delete all memory associated with those messages in thedata storage unit.
DeleteMessage	Deletes the message from the cache and will ensure that all data thatwas tracked for that message is deleted.
DeregisterAll	Deregisters all the messages from the message logger model. This will notremove any data that has been saved, but will stop the messages from beingtracked.
DeregisterMessage	Deregisters the message from the message logger model, which will stop itfrom being tracked each frame. However, the data will not be deleted if themessage is deregistered.
Export	Exports all the data that has been saved to the data storage system. This willsave the data to a CSV file in the directory that is passed in. The data canalso be formatted to a DateTime format and the data can be deleted after ithas been exported.
GetRegisteredMessages	Returns all the messages that are being tracked by the messagewriter model.
PopData	Pops the oldest data from the data storage that is tracking the data and returnsthe JToken data for the object that was being saved. This will go through all themessages stored and will return the oldest data that was saved chronologically onthe message track. If adding the include name parameter, when the data is returned,the ‘m_Name’ field will be added to the JSON object with the name of the messagetype as well as the ‘m_ID’ field with the ID of the message.
ReadClosest	Reads the message data that is associated with the closest value to sometime that is passed in. This will look into the messages that are trackedand will find the closest time to the time that is passed in. This willthen update the data in the message.
ReadLatest	Reads the latest value of the message from the data storage system. Thiswill write the data into the message reference that is passed in.
RegisterMessage	Registers a particular message to the message logger model. This will enablethe message to be copied into the data storage system at each update framebased on the write frequency.

Inherited	Description
Destroy	Removes the current object from the simulation.
FindParentWithID	Returns an attached parent that satisfies the specified ID.
FindParentWithType	Returns an attached parent that satisfies the specified type.
FindRootWithID	Returns a root object that satisfies the specified ID.
FindRootWithType	Returns a root object that satisfies the specified type.