# doc-cache created by Octave 9.1.0
# name: cache
# type: cell
# rows: 3
# columns: 1
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 5
timer


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2449
 -- Function File: timer
     Timer Object Properties and Methods.

     Use a timer to schedule one or multiple executions of tasks
     comprised of callback functions.  If a timer is scheduled to
     execute multiple times, you can specify the time between
     executions.

     Timer properties   Description
     -------------------------------------------------------------------
     AveragePeriod      Average number of seconds between TimerFcn
                        executions.
     BusyMode           Action taken when TimerFcn executions are in
                        progress.
     ErrorFcn           Callback function executed when an error
                        occurs.
     ExecutionMode      Mode used to schedule timer events.
     InstantPeriod      Elapsed time between the last two TimerFcn
                        executions.
     Name               Descriptive name of the timer object.
     Period             Seconds between TimerFcn executions.
     Running            Timer object running status.
     StartDelay         Delay between START and the first scheduled
                        TimerFcn execution.
     StartFcn           Callback function executed when timer object
                        starts.
     StopFcn            Callback function executed after timer object
                        stops.
     Tag                Label for object.
     TasksExecuted      Number of TimerFcn executions that have
                        occurred.
     TasksToExecute     Number of times to execute the TimerFcn
                        callback.
     time               Time when the timer was last updated.
     TimerFcn           Callback function executed when a timer event
                        occurs.
     UserData           User data for timer object.

     Timer       Description
     methods
     -----------------------------------------------------------------------
     timer       Construct timer object.
     delete      Remove timer object from memory.
     display     Display method for timer objects.
     start       Start timer object running.
     startat     Start timer object running at a specified time.
     stop        Stop timer object running.
     waitfor     Wait for timer object to stop running.

     Example: ‘t=timer('TimerFcn','disp
     OK','Period',3,'ExecutionMode','fixedDelay'); start(t);’

     See: https://gitlab.com/farhi/octave-timer

     See also: handle.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 36
Timer Object Properties and Methods.





