<< Click to Display Table of Contents >> Navigation: Explain™ Control Language > Library Routines |
The Gamry Framework™ comes with a built-in set of general-purpose library functions and classes. The Framework library contains both compiled C and Explain routines. These library routines provide essential services such as I/O, time-keeping, potentiostat-control and curve-acquisition.
Each Gamry Instruments application also uses library functions and classes that are specifically designed for that application's measurements. These items are discussed in the Operator's Manuals for each application.
Please visit our website and support page at https://www.gamry.com/support-2/documentation-downloads/ if you need a specific manual for an instrument. |
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.
Convert a quantity to an INDEX. |
|
Find a frequency that rejects line (mains) noise. |
|
Convert Real and Imaginary to Modulus. |
|
Convert Real and Imaginary to Phase. |
|
Round off a REAL to N decimal places. |
|
Normalize an angle to ±360°. |
|
Normalize an angle to ±2π. |
|
Calculate the cosine of a complex number. |
|
Divide two complex numbers. |
|
Compare the values two complex numbers. |
|
Multiply two complex numbers. |
|
New complex number. |
|
Calculate the phase of a complex number in radians. |
|
Set the imaginary component of a complex number. |
|
Set the real component of a complex number. |
|
Calculate the sine of a complex number. |
|
Subtract two complex numbers. |
|
Calculate the tangent of a complex number. |
Gives the dimensions of an array. |
|
Returns the value or object contained in an array element. |
|
Stores a value or object in an array element. |
Convert a character to an ASCII number. |
|
Convert an ASCII number to a character. |
|
Compare two strings. |
|
Get the ith character in a string. |
|
Calculate length of string. |
|
Convert string to lowercase. |
|
Set ith character in a string. |
|
Convert string to uppercase. |
Set a variable to the current time. |
|
Generate a string containing a time. |
Calculate mean of a data set. |
|
Calculate statistics on one data set. |
|
Calculate statistics between two data sets. |
Immediately abort a script. |
|
Halt script until F2-Skip button selected. |
|
Launch a child script and wait for completion. |
|
Pause script for a set number of seconds. |
|
Tell a script to sleep until a specified time. |
|
Allows a user to continue or abort. |
|
Start up a Windows® application. |
|
Let other Windows programs gain control. |
Used in output of data from a class CGEN object. |
|
Prints the Iquant to a string. |
|
Prints the results of a Ivt experiment to the Output file. |
|
Prints the status of the Ivt to a string. |
|
Prints the Label to the current Output. |
|
Prints a label object out to a string. |
|
Output to the current output file. |
|
Output to file with automatic newline. |
|
Output an item to a STRING. |
Updates the headline above the data curve. |
|
Creates, displays, and operates a message box.
|
|
Updates runner window status display. |
|
Secondary update runner window status display. |
|
Opens a dialog box for inputting parameters. |
|
Sends output to the STDOUT window. |
|
Brings STDOUT window to foreground. |
|
Warns operator; waits for OK button to proceed. |
Makes a particular curve the active curve. |
|
Returns the number of points actually acquired in a Cgen object. |
|
Create a new object of the class CGEN class. |
|
Reads the Active Cell flag from a channel object. |
|
Reads the sample area from a channel object. |
|
Reads the test identifier string from a channel object. |
|
Creates a channel object. |
|
Prints the Channel object's notes information to the output file. |
|
Allows a script to set the Active Cell flag in a channel object. |
|
Reads the name of a chemical system from a channel object. |
|
Numerical sorting of classes. |
|
Place class name in a STRING. |
|
Dynamically create a class. |
|
Reports the Aux A/D setting. |
|
Reports the number of the Active Cell (if any). |
|
Releases communications with multiplexer. |
|
Reports Inactive Cell control mode of one selected ECM8 channel. |
|
Acquires the use of an ECM8. |
|
Changes the Aux A/D setting. |
|
Changes the active cell setting. |
|
Set the Inactive Cell control mode for one or more ECM8 channels. |
|
Reports the version number of the ECM8 firmware. |
|
Return a class given a STRING. |
|
Changes the parameters of an existing constant-current signal generator. |
|
Reports the number of the Active Cell (if any). |
|
Releases communications with multiplexer. |
|
Reports Inactive Cell control mode of one selected IMX8 channel. |
|
Acquires the use of an IMX8. |
|
Changes the active cell setting. |
|
Set the Inactive Cell control mode for one or more IMX8 channels. |
|
Allows an Iquant to be edited, saved, and restored in Setup(). |
|
Prints an Iquant to the current Output file. |
|
Sets the value of the Iquant. |
|
Copies the current value of a Iquant into an INDEX. |
|
Returns the number of points actually acquired in an Ivt object. |
|
Creates and returns an object of the class DATACOL. |
|
Runs the curve. |
|
Formats the real-time display of an class IVT curve. |
|
Allows Label objects to be edited, saved, and restored in Setup(). |
|
Creates a new label. |
|
Allows the script to set a label's string from within Explain™. |
|
Copies the Label text into a STRING. |
|
Dynamically creates a new object. |
Recover an old setup on disk. |
|
Save a setup on disk. |
Allows a channel to be displayed and modified in a Setup dialog box. |
|
Enables or disables the Ivt termination limits. |
|
Avoids premature stopping of a curve caused by noise. |
|
Sets up threshold conditions which must be met before Ivt.StopAt() tests are performed. |
|
Gives various parameters. |
|
Dynamically load a DLL library. |
|
Set an *.INI file value. |
|
Interconvert units. |
|
Determine size of a VECTOR. |
|
Generate a new VECTOR. |
Complex number class. |
Sets up multiplexed experiments. |
|
Generates white space in Setup(). |
|
An integer parameter for general use. |
|
A short string for general use. |
|
A multi-line string too long to SAVE/SAVE. |
|
Complex class: 1 class TOGGLE, 1 class QUANT. |
|
An output file. |
|
A real parameter for general use. |
|
Radio button selection. |
|
String used for descriptive purposes. |
|
An on/off parameter for general use. |
|
Complex class: 1 class TOGGLE, 2 QUANTs. |
A potentiostat. |
A constant current. |
|
A constant-voltage signal. |
Generic curve class. |
|
A generic name for all this group's classes. |
|
Generic class IVT curve used for conditioning. |
|
Curve to measure open-circuit potential. |
Array class which can hold any object. |
|
Hold data extracted from class CURVE object. |