May 15, 2024
An implementation of the Gamma scripting language for use in Cogent DataHub™ software.
Application class_ — looks up a translation text. add_menu_action — adds a menu action.allow_self_reference — permits changes to be written back to the point of origin.datahub_command — sends commands to the DataHub program.datahub_domaininfo — gives information about data domains.datahub_domains — creates a list of all domains.datahub_log — writes a string to the Event Log window.datahub_points — shows the points in a data domain.datahub_read — creates a list of all points for a domain.datahub_write — assigns a value to a DataHub point.edit_file — opens a file in the Script Editor. flush_log_file — writes buffered text of Script Log output to the file.freeze_writes — controls when writes are sent to the DataHub engine.get_point_queue_count — counts the number of DataHub points queued for the Gamma
engine.get_point_queue_depth — gets the depth of the DataHub instance's per-point queue for the Gamma
engine.get_tray_menu — returns a pointer to the tray menu.on_change — evaluates an expression when a variable changes value or
quality.remove_change — removes an on_change function.remove_menu_action — removes a menu action.set_log_file — sets the file and open mode for writing Script Log output.set_log_size — sets the maximum log file size for Script Log output.set_point_flush_flags — determines which data types are not buffered.set_point_queue_depth — sets the depth of the DataHub instance's per-point queue for
Gamma.show_log — displays the Script Log.symcmp — compares symbols to see if they are equal.Application.gAddCustomMenuItem — a convenience method for creating a menu item.AddCustomSubMenu — a convenience method for adding a menu.AddMenuItem — adds a menu item and attaches code to it.AddPermanentMenuItem — should not be used.AddStartMenuItem — should not be used.AddStopMenuItem — creates a menu item that destroys the running application.AddSubMenu — creates a submenu on a parent menu.ApplicationMultiple — allows creation of multiple instances of the class.ApplicationSingleton — allows creation of only one instance of the class.CreateSystemMenu — adds a submenu to the system tray menu.droptimer — for internal use only.OnChange — attaches an event handler to a point change event.RemoveAllChanges — removes event handlers from all point change events.RemoveAllEventHandlers — removes all point change events and all timers.RemoveAllMenus — removes all script menus, submenus, and menu actions.RemoveAllTimers — cancels all timers.RemoveChange — removes an event handler from a point change event.RemoveSystemMenu — for internal use only.RemoveTimer — cancels a timer.TimerAfter — attaches an event handler to an "after" timer.TimerAt — attaches an event handler to an "at" timer.TimerEvery — attaches an event handler to an "every" timer.Time.gGetCurrentWindowsTime — returns the current clock time in Windows time format.PointGetUnixTime — gets the Unix time stamp from a point.PointGetWindowsTime — gets the Windows time stamp from a point.PointMetadata — queries a point for its metadata structure.UnixLocalToUTC — converts from local Unix time to UTC.UnixTimeToWindowsTime — converts from Unix time to Windows time.UnixUTCToLocal — converts from UTC Unix time to local time.WindowsLocalToUTC — converts from local Windows time to UTC.WindowsTimeToUnixTime — converts from Windows time to Unix time.WindowsUTCToLocal — converts from UTC Windows time to local time.RegexSupport.gCompile — compiles a regular expression to a form that is more efficient to
evaluate.CompileSubst — compiles a substitution pattern.CompileSubstEx — an alternate interface to CompileSubst.Config — queries the PCRE library for compiled-in options.Exec — applies a regular expression match to a subject string.pcrs_job.Exec — applies a compiled pattern substitution to a subject
string.GetStringNumber — retrieves the index number of named substrings.Match — a convenience function that combines calls to Compile, Study, and
Exec.Study — helpful for speeding up repeated applications of a regular
expression.Subst — applies a substitution pattern to a string of a given
length.Quality.gGetQualityName — converts the quality value of a point to a text string.HistorianSupport.gHistorian — encapsulates the Historian facility in the DataHub program.HistoryBuffer — a set of HistoryValues returned from a Historian
query.HistoryValue — a single value from the Historian, consisting of value, x-axis and
quality.HistTest.g — an example script that demonstrates how to access
Historian data.ModbusSupport.gapply — applies all scripted changes.addPoint — configures a Modbus point.addRange — configures a range of Modbus points.cancel — cancels all scripted changes.createSlave — creates a slave connection.deletePoint — deletes point connections.deleteSlave — deletes a slave connection.enableMaster — enables and disables Modbus master functionality.enableSlave — enables and disables Modbus slave connections.reloadSettings — loads all Modbus configuration.slaveExists — checks for the existence of a slave connection.