timerinfo function

timerinfo(

NAME

)

The timerinfo( function returns a dictionary that contains all of the properties of a timer.

Parameters

This function has one parameter:

name – name of the timer (must have been set up with the StartTimer statement).

Description

This function returns a dictionary that contains all of the properties of the specified timer. You can then use these functions to extract the property values:

getdictionaryvalue( – use a key to retrieve an individual value from a dictionary
listdictionarykeys( – list all of the keys within a dictionary
dumpdictionary( – list all of the keys within a dictionary and their associated values

This example will display how many more times the alarm timer will run.

 local tinfo,truns,trepeats
 tinfo = timerinfo("alarms")
 truns = getdictionaryvalue(tinfo,"RunCount")
 trepeats = getdictionaryvalue(tinfo,"MaxCount")
 if trepeats = 0
     message "alarms will run forever"
 else
     message "alarms will run "+(trepeats-truns)+" more times."
 endif

Error Messages

timerinfo( function error: timer does not exist – There is no timer with the specified name

See Also

appenddictionaryvalue -- appends a value to an item in a dictionary (see Data Dictionaries).
changedictionaryname -- changes the name (key) of an item in a dictionary (see Data Dictionaries).
changedictionaryvalues( -- changes one or more values in a dictionary (see Data Dictionaries).
changetimer -- modifies a repeating task that will be performed periodically when Panorama is not otherwise busy.
clearglobaldictionaryvalues -- clears (removes) all the keys and values from the specified global dictionary.
copypartialdictionary -- builds a new dictionary and initializes it with values from an existing dictionary (see Data Dictionaries).
copypartialdictionary( -- partially copies a dictionary (see Data Dictionaries).
Data Dictionaries -- Overview of Panorama's key/value data dictionaries.
deletedictionaryvalue -- deletes a key/value pair from a dictionary (see Data Dictionaries).
deletedictionaryvalue( -- deletes one or more key/value pairs from a dictionary (see Data Dictionaries).
deleteglobaldictionaryvalues -- deletes one or more global dictionary values.
dictionaryassignmentscode( -- returns code that can be used to take the values in a dictionary (see Data Dictionaries) and assign them to fields or variables based on the dictionary keys.
dictionarydifference -- builds an array that lists keys of dictionary values that are different between two dictionaries (see Data Dictionaries).
dictionaryfromarray( -- builds a new dictionary and initializes it from a two dimensional text array (see Data Dictionaries and Text Arrays).
dictionaryfromvariables( -- builds a new dictionary and initializes it from a list of variables (carriage return delimited).
dictionaryvalueexists -- returns true or false depending on whether or not a key/value pair exists in a dictionary (see Data Dictionaries).
dictionaryvalueexists( -- returns true or false depending on whether or not a key/value pair exists in a dictionary (see Data Dictionaries).
dumpdictionary -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
dumpdictionary( -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
dumpdictionaryquoted -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries).
dumpdictionaryquoted( -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries). The text values are quoted.
dumpdictionarysource( -- returns a carriage return separated array of dictionary keys and values (see Data Dictionaries). The keys and values are quoted so that they could be used to re-assemble the dictionary with the initializedictionary( function.
getdictionarykey -- returns the key of an item in the dictionary, given its value. This is essentially the opposite of the getdictionaryvalue( function (see Data Dictionaries).
getdictionarykey( -- returns the key of an item in the dictionary, given its value). This is essentially the opposite of the getdictionaryvalue( function (see Data Dictionaries).
getdictionaryvalue -- returns the value of an item in the dictionary, given its key (see Data Dictionaries).
getdictionaryvalue( -- returns the value of an item in the dictionary, given its key (see Data Dictionaries).
getglobaldictionary( -- converts a global dictionary into a regular dictionary.
Global Dictionaries -- alertnate high performance method to store multiple data items, much faster than regular data dictionaries.
globaldictionarybuild -- builds a global dictionary by scanning a database.
globaldictionarykeys( -- lists the keys in a global dictionary, or the names of all global dictionaries.
globaldictionaryvalue( -- returns the value of an item in a global dictionary, given its key (see Global Dictionaries).
info("timerinfo") -- returns a dictionary that contains all of the properties of the currently running timer.
info("timers") -- returns a carriage return separated list of all active timers.
initializedictionary -- builds a new dictionary and initializes it with one or more key/value entries (see Data Dictionaries).
initializedictionary( -- builds a new dictionary and initializes it with one or more key/value entries (see Data Dictionaries).
initializedictionaryvalue( -- builds a new dictionary and initializes it with one or more entries (see Data Dictionaries). This function is deprecated, we recommend using the initializedictionary( function instead.
listdictionarykeys( -- returns a list of the keys in a dictionary collection.
listdictionarynames -- returns a list of the names (keys) in a dictionary (see Data Dictionaries).
mergedictionaries -- merges the contents of two or more dictionaries (see Data Dictionaries).
mergedictionaries( -- merges the contents of two or more dictionaries (see Data Dictionaries).
renamedictionarykey( -- changes the key (name) of one or more values in a dictionary (see Data Dictionaries).
setdictionaryvalue -- changes a value in a dictionary (see Data Dictionaries).
setglobaldictionaryvalues -- sets one or more key/value pairs in a global dictionary.
setlocalsfromdictionary -- converts a dictionary into a collection of local variables. The names and values of the local variables will be derived from the dictionary contents.
starttimer -- sets up and starts a repeating task that will be performed periodically when Panorama is not otherwise busy.
stoptimer -- stops and deletes a timer that was set up with the StartTimer statement.
Timer Workshop -- provides a tool for monitoring timers and testing timer configurations.
timerexists( -- checks to see whether a timer exists.

History

Version	Status	Notes
10.0	New	New in this version.