Explain™ fundamentals

<< Click to Display Table of Contents >>

Navigation:  Explain™ Control Language  >

Explain™ fundamentals

Description

An Explain script is a simple ASCII text file you might create with any editor, even the infamous EDLIN. We recommend you use Windows® Notepad or the built-in editor for editing scripts.

 

Gamry tip bulb

You cannot use a word processor like WordPerfect® or Word for Windows. They leave formatting and font information in the script, which the compiler cannot process.

 

Gamry tip bulb

Explain uses tab indentation to mark program blocks. Many editors, including the DOS EDIT program, substitute spaces for tabs in a file. The Explain compiler is unable to read a file with spaces in place of tabs. Do not use the DOS EDIT program to modify an Explain script!

 

Run an Explain script by selecting it from the Framework Experiment menu. Framework creates a runner window as the first step in executing the script. Behind the runner window, a compiler built into the Framework turns the script into a tokenized (machine-executable) form. This accounts for the short delay you may notice at the start of each experiment. Following the compilation, an interpreter takes the tokenized code and starts running it. When the code runs, visible changes happen to the runner window. We refer to these separate phases of running as the Compiler and the Interpreter.

 

This Help section gives you the fundamental information necessary to understand what happens in an Explain script. Explain library functions for each Gamry Instruments application are described in that application's Help section.

 

Coding Guidelines

We use UPPERCASE names to refer to class names and Mixed-Case names to refer to object names:

 

LABEL refers to a class.

Label refers to an object.

 

Because Explain is case-sensitive, LABEL and Label are two completely different names. In this manual, when a Mixed-Case object name is the same as a UPPERCASE class name, you may assume the object is of that class.

 

When an ASCII <tab> character appears in sample output, it is indicated as:

 

TEXT <tab> MORE TEXT

 

The terms CURVE and Curve object are used in this section to refer to the various classes of objects that acquire and hold run-time data. An example is the OCV class.