Heartbeat

Heartbeat - Object heartbeat control

Synopsis
object class { heartbeat time-modulo; }

Description
The object heartbeat determines the number of seconds that elapse between calls to the heartbeat_class export function. If the object heartbeat is zero or if the object's class does not export the heartbeat function, the heartbeat is not called. By default the object heartbeat is zero.

When the heartbeat function is called, the object has the opportunity to set the time of the next object update, which is by default NEVER.

The purpose of the heartbeat is to allow objects to preschedule sync times without relying on the sync call loop to ensure that the next sync time gets scheduled. The prototypical object with this problem is the recorder, which sometimes must schedule syncs to occur every n seconds. Prior to this could not be done and it was necessary for sync calls to anticipate the next event, which would cause all objects to be updated with sync calls even when it's obvious that nothing needs to be or should be changed. See GridLAB-D Forum Topic 5227211 for more information.

Version
The heartbeat property was introduced in.