Contents - Index


Macro Commands

 

The macro commands recognized by EES are listed below in alphabetical order.  Note that macros can only be created in the Professional version.  Comments can be included on the same line as the macro command, beginning with characters //.

 

 

AddPlotText 'PlotTabName'  Xpos Ypos 'PlotText'  TextSize Plain Red

Create a text item on the plot window that is identified with 'PlotTabName' as the name on the tab.  PlotTabName can be a string constant (surrounded with single quotes) or a string variable that has been defined.  Xpos and Ypos determine the starting point of the text.  Values of  Xpos, Ypos of  0, 0 correspond to the lower left corner of the plot rectangle.  Values of  Xpos,Ypos of 1, 1 correspond to the upper right corner of the plot rectangle.  PlotText can be a string constant or a string variable.  TextSize is the font size of the text; it can be supplied as a numerical constant or as an EES variable.  The font style must be plain, bold, or italic.  The color can be supplied as a string constant or string variable.  The colors are identified in the NewPlot macro below.   

 

AlterValues 'Table 1' X Rows=1..10  First=100 Last=550 {or Inc=50 or Mult=1.1}

AlterValues 'Table 1' X Rows=1..10  Clear

Enter values into the Parametric Table named 'Table 1' for the column holding variable X setting the values of rows 1 to 10 to values starting at 100 and ending at 550. You can specify Inc=50 or Mult=1.2 in place of specifying the value of Last.  If Clear is specified, the cells in the specified column will be cleared.  Variables can be defined in the macro and used in place of the numbers for the rows and values used to fill the column.  For example, the following command will work provided that R1, R2, X1, and XN are previously defined.

 

        AlterValues 'Table 1' X Rows=R1..R2 First=X1 Last=XN

 

Assign EESVariable=value

Assign a numerical EES variable to a value.  The variable remains assigned to this value until it is reassigned.  A variable assigned with a macro command cannot be reassigned in the Equations window.   Note that the keyword Assign is optional.

 

Assign EESStringVar$='string constant'

Assign an EES string variable to a string constant.  The string variable must have a name that ends in a $ character.  The string constant is contained with in single quotes.  String variables can be used as filenames in the SaveTable and other file-related macro commands. The Assign keyword is optional.

 

Beep 3

Execution of this command will result in an audible sound.  An integer between 1 and 5 can optionally follow the beep keyword.  If the integer is present, EES will play the specified sound defined in the Sound tab of the Preferences dialog.  Otherwise it will just sound the default beep.

 

Check

Check the equations.  A summary statement is not issued.  This command is useful only in rare situations in which it is necessary to have EES review the existing equations before processing following Macro commands.

 

ClearLookupColumn 'TableName'  'ColumnName' StartRow EndRow

Clear the values in the specified column of the Lookup table named 'TableName'.  'TableName' can be either a string constant or a string variable defined in the EES program or macro.  The column that is cleared can be identified by its name or by its column number.  The column name can be represented by a string constant or a string variable.  Alternatively, the column number can be an integer or an EES variable defined in the EES program or the macro.  StartRow and EndRow are optional.  If they are provided, they can be either integers or EES variables with their values set before the macro command is executed.

 

Copy /H ArraysTable 'TableName'  R1 C1:R10 C4

Copy the specified range of the Arrays table to the clipboard.  Often there is only one arrays table for the main equation window with TableName='Main'.  If TableName is not specified, 'Main' will be assumed.  Note that the R and C characters are required.  For example, this macro command will copy the Arrays table starting in row 1, column 1 through row 10 column 4.  The data in this selection range will be placed on the clipboard.   If no range is provided, the entire table is copied.  It is possible to specify the selection range with string variables.  For example, string variables R1$ and C1$ can be defined in the macro commands or within the EES program as 'R1' and 'C1', respectively.  String variables R2$ and C2$ can be defined as 'R10' and 'C4', respectively.  Then, the macro command Copy ArraysTable R1$ C1$ : R2$ C2$ will provide the same effect as the original example.  Note that the strings must include the leading 'R' or 'C' characters and can be generated using the CONCAT$ and STRING$ functions, e.g., R2$=concat$('R',string$(X)).  If the value of X has been previously set to 10, using R2$ assigned in this manner will provided the same effect as the original example.  The /H option will copy the column names and units.

 

Copy Diagram 'Child Window Name'

Copy the specified Diagram window to the clipboard.  A window name, e.g., 'Child Window Name' can optionally be provided as a string constant (within quotes) or as a string variable.  (The window names are displayed in the Diagram Window flyout menu accessed from the Windows menu in the main menu bar.)  The Diagram window corresponding to the provided name will be copied to the clipboard.  If the name is not found, or if the name is 'Main' or if no name is provided, the main Diagram window will be copied to the clipboard.

 

Copy /H IntegralTable R1 C1:R10 C4

Copy the specified range of the Integral table to the clipboard.  The range specification is explained in the Copy ArraysTable macro command above.   If no range is provided, the entire table is copied.  The /H option will copy the column names and units.

 

Copy EquationWindow L3 C1:L5 C9

Copy the characters in the Equations WIndow starting with character 1 on line 3 through character 9 on line 5

 

Copy /H LookupTable 'Lookup 1' R1 C1:R10 C4

Copy the specified range of the Lookup table with name 'Lookup 1' to the clipboard.  The range specification is explained in the Copy ArraysTable macro command above.   If no range is provided, the entire table is copied.  The /H option will copy the column names and units.

 

Copy /H ParametricTable 'Table 1' R1 C1:R10 C4

Copy the specified range of the Parametric table named 'Table 1' to the clipboard. The range specification is explained in the Copy ArraysTable macro command above.   If no range is provided, the entire table is copied.  The /H option will copy the column names and units.

 

Copy PlotWindow 'Plot name'

Copies the graphics in Plot Window in the specified plot window.  'Plot name' can be an integer.  For example, if  'Plot Name' is 3, the plot that is in the third tab of the plot window will be copied.  More commonly, 'Plot Name' will be the name of the plot shown in the tab at the top of the plot window.   The plot is copied in the format specified in the Plot tab of the Preferences dialog.

 

Copy SolutionWindow

Copies the entire contents of the Solution window in ASCII format.

 

DefVarInfo  T guess=5 lower =4  upper=6 display=F2 units='T'

DefVarInfo sets the default variable information for all variables beginning with letter following the DefVarInfo keyword, in this case, T.  The defaults for the guess value, lower and upper bounds, display format and units can all be set in this manner.

 

Delay 100

Pause execution for a specified number of microseconds.  This command is useful when the EES macro file is being cycled and EES is periodically reading a file (with its Import command) that has been written to a disk by another application, such as a data acquisition program.  This command differs from the Pause command only in that the argument is in microseconds. 

 

Delete 'FileName'

Delete the specified file. FileName can be a string variable (ending with character $) or a filename enclosed in single quotes.

 

DeleteLookup 'TableName' or DeleteLookup 1

Delete the specified Lookup table.  The Lookup table can be indicated by: 1) providing its name (optionally surrounded in single quotes), 2) providing a string variable that contains the name of the table or 3) by providing a number indicating the position of the table.  The first table is number 1.

 

DeleteParametric 'TableName' or DeleteParametric 1

Delete the specified Parametric table.  The Parametric table can be indicated by: 1) providing its name (optionally surrounded in single quotes), 2) providing a string variable that contains the name of the table or 3) by providing a number indicating the position of the table.  The first table is number 1.

  

DeletePlot 'my Plot'

Delete the plot window that has a plot window tab name of 'my Plot'.  Note that the name of the plot window tabs must be either a string constant within single quotes or a predefined EES string variable.  The test for the plot tab name is case insensitive.  (An older format is supported in which an integer representing the tab order of the plot window is provided in place of the plot tab name.)

 

DuplicatePlot 'my Plot'   'your Plot'

If a plot window having a tab name of 'my Plot' exists, create a copy of the plot and set its tab name to 'your Plot'.   Note that the names of the plot window tabs must be either string constants within single quotes or predefined EES string variables.  The test for the plot tab name is case insensitive.

 

EXCEL.Cell(A1,'text')  

The two parameters separated by a list separator character can be predefined EES string variables.  The first parameter indicates the cell location.  The letter provides the column and the number provides the row.  The second parameter provides the text that will be placed in the specified cell in a previously opened EXCEL file.

 

EXCEL.FileNew

Start EXCEL if it is not already open and create a new empty worksheet.

 

EXCEL.FileOpen('FileName')

Start EXCEL and open the specified EXCEL file.  It is necessary to provide the complete file name, including the filename extension, e.g., 'C:\EES32\USERLIB\EXAMPLES\EXCEL_WS1.xlsx'.

 

EXCEL.FileSaveAs('FileName')

Save the current EXCEL file with the specified filename. It is necessary to provide the complete file name, including the filename extension, e.g., 'C:\EES32\USERLIB\EXAMPLES\EXCEL_WS1.xlsx'.

 

EXCEL.Hide

Hide the open EXCEL application.

 

EXCEL.Paste

Paste the current contents of the Clipboard into EXCEL at the current selection point.  (See EXCEL.RANGE)

 

EXCEL.RANGE('A2:C4')

Set the selection for the active EXCEL worksheet.  In this example, A2 is the upper left corner of the selection and C4 is the lower right corner of the selection.  To set the insertion point for a paste operation, set the upper left and lower right corners to the upper left of the insertion point, e.g., 'A1:A1'.

 

EXCEL.Quit  

Close EXCEL and shut down communication.

 

EXCEL.Sheet('Sheet2')

Activate the EXCEL sheet with the given name in the current EXCEL application.  If this sheet does not exist, a new sheet having this name will be created and activated.

 

EXCEL.Show

Make the open EXCEL worksheet visible.

 

Export /A 'FileName'  X,Y,Z

Export opens the specified file and writes the values of the specified EES variables to that file.  Filename can be Clipboard.  This command has the same format and options as the $EXPORT directive.  For example, the optional /A appends the specified data to the existing file.

 

ExportText /A 'FileName'  S$[1..4]

ExportText opens the specified file and writes the values of the specified EES variables to that file with each string on a separate line.  Filename can be 'Clipboard'.  This command has the same format and options as the $ExportText directive.  Array range notation can be used to specify the string variables.   The optional /A appends the specified data to the end of an existing file.

 

GetDirectory

F$=GetDirectory will assign the specified string variable (F$ in this case) to the current Windows directory.

 

GetFirstFile$(*.XXX,RECURSE)

GetFirstFile$ will return the complete file name (including the path) of the first file found in the current directory having a file name extension of *.XXX.  The file name is assigned to a string variable, as shown in the example.  The directory can be selected with the SetDirectory macro command.  The GetFirstFile$ command is normally used with the GetNextFile$ command do obtain a complete list of all files in a directory with the specified file name extension.  If a file having the specified file name extension does not exist, the GetFirstFile$ macro command will return a null string ('').  This command can be used to open and solve multiple EES files, as shown in the example, or to open and process multiple data files that are read into a lookup table.  The ,RECURSE parameter is optional. If it is provided, this command will look in all subdirectorires contained within the current subdirectory and include ALL files in all subdirectories in the list.

 

Example: (open and solve all EES files in a directory)

SetDirectory('d:\testmacro')

F$=GetFirstFile$(*.ees)

if (F$='') then quit

repeat

     Open   F$

     solve

     pause 1

     F$=GetNextFile$

until (F$='')

 

GetNextFile$

GetNextFile$ can only be used after the GetFirstFile$ macro command.  It returns the next file in the directory having the file name extension supplied in the GetFirstFile$ command.  Each use of the GetNextFile$ command will increment an internal counter and return the following file name in the directory.  After the last file is found, a following call to GetNextFile$ will return a null string ('').  See the example provided for GetFirstFile$.  Only one set of GetFirstFile$/GetNextFile$ can be active in a macro, i.e., nested use is prohibited.  

 

GOTO 10

Transfer execution of the next macro command to the line having label 10.  Labels must be numerical values ranging between 1 and 30000 followed by a colon (:).  Labels will usually be used with the IF THEN ELSE command, e.g., IF (X<Y) then GOTO 10.  They are also used with the ONERROR GOTO XX command.

 

HideWindow WindowName

This command will hide the specified window.  WindowName can be any of the following:  EES, Equations, ErrorMessages, Formatted, Solution, Residuals, Arrays, Parametric, Lookup, Integral, Plot, Diagram, ErrorMessages.  Note that HideWindow EES will hide the EES application and all windows associated with it. HideWindow ErrorMessages will prevent any error messages from displaying when a macro is started with the Play button in the Macro window.

 

If (X<=Y) OR (Y=2) then Z=3 else Z=4

The If THEN ELSE command in a macro file can test variables that have been defined in the macro or set in the previous execution of the Solve command.  The tests can use any of the following logic operators: <, <=,  =,  <>,  >, >=  .  The IF test can used one or more AND and OR operators.  The AND and OR must be surrounded by spaces.  The order of the logical operations can be controlled by parentheses.  The entire command must be all on one line.  The ELSE clause is optional. The IF command will usually be used with the GOTO command and line labels.  Note that X and Y can be string constants or string variables.  However, in this case, only the = and the <> logic operators are applicable.

 

Import 'FileName'  X,Y,Z

Import opens the specified file and reads the values of the specified EES variables from that file.  Filename can be Clipboard.  This command has the same format and options as the $IMPORT directive.

 

ImportText 'FileName'  S$[j..k]

ImportText opens the specified file and reads the text information in the specified EES string variables.  Filename can be Clipboard.  Note that array range notation can be used with a string array, provided that the indices (j and k) are predefined. This command has the same capabilities and options as the $ImportText directive.

 

InsertLookupColumn 'TableName' After 'ColumnName\Units' ColumnFormat

Inserts one column into the existing Lookup table that has name (showing on the tab in the window) TableName.  TableName may be a string variable containing the name of the table.  The column is inserted after column number After, where After is an integer.  If After is 0, the column will be inserted as the first column in the table.  If After is greater than the number of columns in the table, the column will be inserted as the last column in the table.  'ColumnName\Units' is optional.  If 'ColumnName\Units' is provided, the column name will be set to "ColumnName' and its units will be set to Units.  'ColumnName\Units' may be a string variable.  Note that a \ separates the column name and the units.  If a \ is not provided, the units will be left blank.  ColumnFormat is optional.  If this field is provided, the 'ColumnName\Units' field must also be provided.  ColumnFormat is a 2 digit field.  The first digit can be A (auto), F (fixed decimal), E (float decimal), T (time format), D (date format) or S (string).  The second digit is a number between 0 and 9 for numerical format.  For Time format, the second digit must between 0 and 2.  For Date Format, the number must be between 0 and 9. 

 

InsertLookupRows 'TableName'   After  NRows

Inserts NRows into the existing Lookup table that has name (showing on the tab in the window) TableName.  TableName may be a string variable containing the name of the table.  If NRows is not provided, it is assumed to be 1.  The row(s) are inserted after row number After, where After is an integer.  If After is 0, the row will be inserted as the first row in the table.  If After is greater than the number of rows in the table, the row will be inserted as the last row in the table. After and NRows may be variables defined in the macro or in the EES program.  If NRows<0 this command will delete rather than insert the rows.

 

InsertParametricRuns 'TableName'   After  NRuns

Inserts NRuns into the existing Parametric table that has name (showing on the tab in the window) TableName.  TableName may be a string variable containing the name of the table.  If NRuns is not provided, it is assumed to be 1.  The runs(s) are inserted after run number After, where After is an integer.  If After is 0, the run will be inserted as the first run in the table.  If After is greater than the number of runs in the table, the run will be inserted as the last run in the table. After and NRuns may be variables defined in the macro or in the EES program. If NRuns<0 this command will delete rather than insert the runs.

 

Label 10:

Create a a line with label 10:  Line labels are numbers between 1 and 30000 that end with a colon.  Another command can follow the line label on the same line.  The Label keyword is optional.  An example is 10: X=X+1.  Labels are useful with the GOTO and the ONERROR GOTO macro commands.

 

Load #n

This command is useful only for macro files (.emf filename extension) that control the execution of a distributable file.  The distributable file can contain up to 100 separate programs.  This command will clear the memory space and then load program n where n is a number between 1 and the number of programs provided with the distributable program. 

 

LoadLib C:\EES_Library_Files

Open directory C:\EES_Library_Files and load all the  library files in this directory and folders within this directory.

 

Log 'Message' or ON/OFF

If the word OFF appears after the Log keyword, logging of information to macro log file will cease.  If the word ON appears after the Log keyword, logging of information to the macro log file will be resumed.   If a message other than ON or OFF follows the Log keyword, the message will be written to the log file that is created when the macro is played.  'Message' can be a string constant or an EES string variable.  Macro commands are processed sequentially.  The log file may be helpful for debugging a macro command file.

 

LogFileName  FileName

By default, EES writes a log file showing each of the macro commands that it executed.  The log file name is named, by default, EESMacro.log, and it is placed in the same directory as the macro file.  However, you can change the filename for the log file with the LogFileName macro command.  The Filename that follows the LogFileName keyword normally has a .log filename extension, but any extension representing a text file is appropriate.  The directory can be indicated in the filename.  If a directory is not specified, the log file will be placed in the same directory as the macro file.  Note that Filename cannot be represented with an EES string variable.  If a filename is not provided after the LogFileName keyword (i.e., the filename is blank) a log file will not be written. Also, this command must appear on a line by itself, without a preceding statement label. 

 

LOOKUP['Table Name', Row, Column]=Value

Set the value of the cell at the specified row and column of the specified Lookup table to the given value.  Column must either be an integer, referring to the column number or a string constant or string variable that provides the name of the column.  Note that brackets (rather than parentheses) are required.

 

LOOKUP$['Table Name', Row, Column]=F$

Set the value of the cell at the specified row and column of the specified Lookup table to the given string.  F$ can be a string constant or string variable (ending with a $ sign as shown)  Column must either be an integer, referring to the column number or a string constant or string variable that provides the name of the column.  Note that brackets (rather than parentheses) are required and that the column in the Lookup table must be designated for string variables.

 

LookupColInfo  'LookupTableName'  Column#  'ColumnName\Units'  ColumnFormat

LookupColInfo sets the name and units of a column in an existing Lookup table.  The name of the table (which appears on the window tab) is 'TableName'.  'TableName' can be a string constant or EES string variable.  Column# is an integer between 1 and the number of the columns in the table.  Column# can be provided in a variable defined in the macro.   The column name will be set to "ColumnName' and its units will be set to Units.  'ColumnName\Units' may be a string variable.  Note that a \ separates the column name and the units.  If a \ is not provided, the units will be left blank.  ColumnFormat is optional.  ColumnFormat is a 2 digit field.  The first digit can be A (auto), F (fixed decimal), E (float decimal), T (time format), D (date format)  or S (string).  The second digit is a number between 0 and 9, except for time format, where it must be between 0 and 2. 

 

MATLAB.Execute('MATLAB Command')

Execute the MATLAB command.  The command can be a string constant or a string variable.  The command is executed in the MATLAB command window.  The MATLAB command is case-sensitive.  It must be entered exactly as it would be entered in the MATLAB Command Window.  The result of the command is displayed in the macro log file.  Note that MATLAB.Open command must be used before this command can be issued.  Example:  MATLAB.Execute('version').  

 

MATLAB.Open

Start MATLAB and open the MATLAB Command Window.

 

MATLAB.Quit

Close the instance of MATLAB opened with the MATLAB.Open macro command.

 

Maximize G  a  b  c  /Method=Direct

Maximize variable G with respect to variables a, b, and c.  Note that the all variables must be defined in the Equations Window and variables a, b, and c must have non-infinite lower and upper limits.  The VarInfo macro command can be used to provide limits.  The optimization method specification is optional.  If it is provided, it can appear can be appear anywhere after the Maximize keyword.  The optimization method keyword following the equal (=) sign can be Golden or Quadratic for single degree of freedom optimization problems.  For two or more  degrees of freedom, the keyword can be Direct, Variable, Genetic, or Nelder.  If no optimization method is provided, EES will use the method that was last used. 

 

MaximizeTable  /S /U /R  G  a  b  c  /Table='TableName'  /Rows=1..10  /Method=Direct

Maximize variable G with respect to variables a, b, and c for rows 1 through 10 in the Parametric table having name 'TableName'.  Variables G, a, b, and c must exist in the specified Parametric table.  TableName can be a string variable.  The numerical values following the /Rows keyword can be EES variables.   Note that variables a, b, and c must have non-infinite lower and upper limits.  The VarInfo macro command can be used to provide limits.  The optimization method specification is optional.  If it is provided, it can appear can be appear anywhere after the Maximize keyword.  The optimization method keyword following the equal (=) sign can be Golden or Quadratic for single degree of freedom optimization problems.  For two or more  degrees of freedom, the keyword can be Direct, Variable, Genetic, or Nelder.  If no optimization method is provided, EES will use the method that was last used. If the /Rows keyword is not provided, the first and last rows last used in a Parametric table calculation will be assumed. If /U is provided, the guess values will be updated after each row of the table sucessfully completes calculations.  If /R is provided the calculations will be start on the last row and proceed to the first row of the specified range.  If /S is provided the calculations will stop if an error is encountered and remaining rows of the table will not be processed.

 

MessageDialog([OK, Cancel], 'message text')

MessageDialog will put up a user-provided message dialog with 1, 2 or 3 buttons.  The button captions (which each should be less than 16 characters) are provided in brackets as the first parameter.  For example, [OK, Cancel] will result in a message dialog with two buttons captioned OK and Cancel.  The message text is the second parameter and it can be either a string constant (surrounded by single quotes) or a string variable (ending with a $).  The message text can reference a URL.  For example, the message text could be 'Please visit http:\\fchart.com.  Press the OK button when you return.'   The URL name is hot so that clicking on it will start your browser and point it at the specified URL.  Note that backslash \\ characters must be used because  is interpreted to be the start of a comment.  The dialog will optionally return the button number (1, 2, or 3) if a variable name is provided in the following manner.  R=MessageDialog([OK, Cancel], 'message text').  In this case R will be set to 1 if the OK button is selected and it will be set to 2 if the Cancel button is selected.

 

Minimize G  a  b  c /Method=Nelder

Minimize variable G with respect to variables a, b, and c.  Note that the all variables must be defined in the Equations Window and variables a, b, and c must have non-infinite lower and upper limits.   The VarInfo macro command can be used to provide limits.  The optimization method specification is optional.  If it is provided, it can appear can be appear anywhere after the Minimized keyword.  The optimization method keyword following the equal (=) sign can be Golden or Quadratic for single degree of freedom optimization problems.  For two or more  degrees of freedom, the keyword can be Direct, Variable, Genetic, or Nelder.  If no optimization method is provided, EES will use the method that was last used. 

 

MinimizeTable /S /U /R  G  a  b  c  /Table='TableName'  /Rows=1..10  /Method=Genetic

Minimize variable G with respect to variables a, b, and c for rows 1 through 10 in the Parametric table having name 'TableName'.  Variables G, a, b, and c must exist in the specified Parametric table.  TableName can be a string variable.  The numerical values following the /Rows keyword can be EES variables.   Note that variables a, b, and c must have non-infinite lower and upper limits.  The VarInfo macro command can be used to provide limits.  The optimization method specification is optional.  If it is provided, it can appear can be appear anywhere after the Maximize keyword.  The optimization method keyword following the equal (=) sign can be Golden or Quadratic for single degree of freedom optimization problems.  For two or more  degrees of freedom, the keyword can be Direct, Variable, Genetic, or Nelder.  If no optimization method is provided, EES will use the method that was last used. If the /Rows keyword is not provided, the first and last rows last used in a Parametric table calculation will be assumed. If /U is provided, the guess values will be updated after each row of the table sucessfully completes calculations.  If /R is provided the calculations will be start on the last row and proceed to the first row of the specified range.  If /S is provided the calculations will stop if an error is encountered and remaining rows of the table will not be processed.

 

ModifyAxis X Name='my Plot' Min=100 Max=600 Int=100 Linear Grids=on Showscale=off Size=10 Style=BoldItalic Format=A3 Color=Black

Change the scaling of the X axis of the specified plot window.   The plot window is specified by providing the name of the plot window tab in after the Name= keyword.  The plot tab name must be either a string constant within single quotes or a predefined EES string variable.  This commands allows the axis to be changed to the specified minimum, maximum and interval in linear or log coordinates.  The scale numbers are shown in bold italic with fontsize 10 using automatic format. The grid lines and scale can be turned on or off.  Use Y for the left Y axis and Y2 for the right Y axis.  Color controls the color of the plot text and it must be recognized color name.   

 

ModifyPlot Name='my Plot' Width=12 cm Height=15 cm  GridColor=Teal

Change the size of plot rectangle for the specified plot window.  The plot window is specified by providing the name of the plot window tab in single quotes after the Name= keyword.  The plot tab name must be either a string constant within single quotes or a predefined EES string variable.   Size can be specified in cm or in.  The grid color must be a recognized color name.   

 

New

Clear the workspace and bring up an empty Equations windowThe NEW macro will not display a dialog asking you to save an existing file.  The existing file will be closed without saving.

 

NewContourPlot  Table=PAR1  X=x  Y=y  Z=z  TYPE=Isometric  LEGEND=YES  RESOLUTION=25  XMIN=0  XMAX=1 XINT=0.1 ZINT=0.2 NAME='my Plot'

This command creates a new contour plot in which contours of variable identified by Z are displayed in one of three ways as a function of variables identified by X and Y.  The data used to construct the plot are taken from the specified table.  The table can either be identified by its name within quotes or by specifying the identifier for the table (PAR, LOOK, ARR, INT, followed by the position of the table.  For example, PAR1 designates the first parametric table.  ARR or ARR1 designates the first arrays table.  The three types of plots are identified by keywords: Isometric, Colorbands, and Gradient.  The Legend and Resolution are optional.  If Legend is provided, it must be followed by =Yes or =No.  Resolution must be followed (without spaces) by a equal sign and a number that is between 0 and 100.    A default value is used if no resolution is provided.  The minimum, maximum and interval of the values for the X, Y and Z variables may be optionally specified. Default values will be provided if these data are not provided.  The plot tab name is set to 'my Plot'.  The the plot tab name must be either a string constant within single quotes or a predefined EES string variable. Note that only plots based on 3 columns of data are currently supported.  

 

NewLookup 'Lookup 1' Rows=24  Cols=2

This command creates a new Lookup table having name 'Lookup 1' with 24 rows and 2 columns.  Note that the table name can be a string variable that has been previously assigned in the macro.  Also, previously assigned variables can be used in place of the numerical values for the number of rows and columns, e.g, NewLookup T$ Rows=N Cols=N

 

NewPlot  Name='My Plot'  Table='myTable'  X=P2  Y=T2  Rows=1..10  Line=1  Symbol=1  SymbolSize=6  Color=Red  Legend  ErrorBars

Create a new plot window.  Set the name of the tab for this plot window to ' My Plot'.  Note the plot tab name must be either a string constant within single quotes or a predefined EES string variable.  Plot variables T2 vs P2 using the first 10 rows of data from the Parametric table, Lookup table  or Arrays Table that has the name 'myTable'.  Note that the table name can be provided as a string variable, e.g., TN$.  (If  'myTable' is the name of both a Parametric table and a Lookup table, the data will be plotted from the Parametric table.  The search order is Parametric table, Lookup table and then Arrays table)   Use plot symbol 1 with a size of 6 pixels.  Allowable sizes range from 4 to 18.  Note that the table could also have been identified by entering PARN, LOOKN, or ARRN where N is the tab number of the Parametric, Lookup or Arrays table.  You can also use ARR for the first arrays Arrays table or INT for the Integral table.  When plotting variables from the Arrays table (ARR or ARRN) specify the array name as XXX[i], where XXX is the parent name of the array variable.  The Legend keyword causes a legend item to be created.  Note that the Line, Symbol, SymbolSize and Color can be specified using integers or variables.  The coding for these parameters is as follows:

 

Line=0  No line Symbol=1  Open circle Color=0  Black

Line=1  Solid line                Symbol=2  Open rectangle Color=1  Blue

Line=2  Dotted line            Symbol=3  Open triangle (up) Color=2  Red

Line=3  Thick line             Symbol=4  Open butterfly (horiz) Color=3  Green

Line=4  Dashed line         Symbol=5  Open triangle (down) Color=4  Purple

Line=5 Thick dotted Line Symbol=6  Open butterfly (vert) Color=5  Maroon

Line=6  Thick dashed line   Symbol=7  Open diamond Color=6  Yellow

Line=7  Dash-dot line         Symbol=8  Closed circle  Color=7  Lime

Line=8  Thick dash-dot line  Symbol=9  Closed rectangle  Color=8  Aqua

                               Symbol=10 Closed triangle (up)  Color=9  Gray

                      Symbol=11 Closed butterfly (horiz)  Color=10 Fuchsia

Symbol=12 Closed triangle (down)  Color=11 Navy

Symbol=13 Closed butterly (vert)   Color=12 Teal

Symbol=14 Closed diamond    Color=13 Silver

Symbol=15 Cross                   Color=14 Orange

  Color=15 White

 

The ErrorBars keyword will cause error bars to be drawn if the data that are plotted contain uncertainty information.  All parameters except Table, X, and Y are optional.  A default value will be used if a parameter is not specified.

 

 

NewTable 'Table 1'  Rows=10 X Y Z

Create a new Parametric table having name 'Table 1' with 10 rows and columns for variables X, Y and Z.   Note that the table name can be a string variable that has been previously assigned in the macro.  Also, previously assigned variables can be used in place of the numerical values for the number of rows, e.g, NewTable T$ Rows=N  X Y Z

 

ONERROR GOTO XX

Normally, if an error of any kind occurs during execution of macro commands, execution will stop and an error message will be posted.  The ONERROR macro command provides a way for this default behavior to be modified.  After this command has been executed, an error will result in a jump to the macro command having label XX.  A line with this label must appear in the macro file.  Labels must be numerical values ranging between 1 and 30000 followed by a colon (:).  This command can appear as many times as desired.  The control will transfer to the macro command with the label for the most recently executed ONERROR command.  To return to default behavior, enter ONERROR GOTO 0.

 

Open C:\EES32\Examples\Regen.ees 

Open the specified file.  The file name can be a string variable or string constant.

 

OpenLookup  C:\EES32\myTable.lkt   

Open the specified Lookup fileIf ? is provided in place of a file name, a select file dialog will appear in which the file name can be chosen.  The table having this file name will then be opened.  The filename can be followed with a /FORMAT 'format.fmt' specification that directs the Lookup file to be read using a format specification file having a .fmt filename extension.  A string variable can be provided after the ?.  If provided, the string variable is set to be the name of the Lookup table that has been created.  This name is valid for the remainder of the macro file execution. Example:  OpenLookup ? TableName$

 

OverlayPlot Name='my Plot' Table='myTable'  X=P[4]  Y=Eff  Rows=1..10  Line=1  Symbol=4  SymbolSize=10 Color=Blue Right Legend ErrorBars

Overlay a plot of variables Eff vs. P[4] from data in rows 1..10 of the Parametric table, Lookup table or Arrays table that has the name 'myTable'.  Note that the table name can be provided as a string variable, e.g., TN$. The plot window that the data will be plotted on is specified by providing the name of the plot window tab after the Name= keyword.  The plot tab name must be either a string constant within single quotes or a predefined EES string variable.   By default, data are plotted on the left Y axis.   The Right keyword indicates that the data will be plotted on the right Y-scale.  Use plot symbol 4 with a size of 10 pixels.  Allowable sizes range from 4 to 18.  Note that the table could also have been identified by entering PARN, LOOKN, or ARRN where N is the tab number of the Parametric or Lookup tables.  You can use ARR for the first Arrays table or INT for Integral table. The Legend keyword causes a legend item to be created. The Symbol, SymbolSize, Color and Line indicators may be an integer or an EES variable.  The ErrorBars keyword will cause error bars to be drawn if the data that are plotted contain uncertainty information. See the information under NewPlot for the relation between the value and the indicator.  Note that all of the parameters except the plot window, table name, and X and Y specifications are optional.  

 

Parametric['Table 1',1,4]=20

Set the value in row 1 column 4 of the Parametric table named 'Table 1' to 20.  Note brackets (and not parentheses) are required.

 

Paste Lookup 'Lookup 1' /A  R2 C3

Paste the contents of the clipboard into the Lookup table named 'Lookup 1' starting at row 2 column 3.  The /A is optional.  If present, the paste operation will add more rows to the table if needed.  

 

Paste Parametric 'Table 1' /A  R2 C3

Paste the contents of the clipboard into the Parametric table named 'Table 1' starting at row 2 column 3.  The /A is optional.  If present, the paste operation will add more rows to the table if needed.  

 

Pause  2.5

Pause execution for a specified number of seconds.  This command is useful when the EES macro file is being cycled and EES is periodically reading a file (with its Import command) that has been written to a disk by another application, such as a data acquisition program.  (The Delay command provides the same capability, but the argument is in microseconds instead of seconds.)

 

Print Diag Equ For Arr1 Par2 Look3 Plot1

Print the Diagram, Equations, FormattedEqns, Arrays, the Parametric table in the second tab of the Parametric Table, the Lookup Table in the 3rd tab of the Lookup Table and Plot 1 windows 

 

PrintSetup  PRINTER='\\SEL\Sandy'  Orientation=PORTRAIT  Copies=1

Set the printer specifications

 

PropPlot Steam TS 4 11000 5300 2100 660 6 0.074 0.94 3.37 12 45 155 DoQLines

Create a TS property plot for Steam.  Include 4 constant pressure lines and 6 constant entropy lines at the specified values and draw lines of constant quality.  Note that the values for the constant pressure and constant entropy lines can be set with previoulsy defined variables as well as with numerical values. 

 

PropPlot AirH2O PSY 6 10 15 20 25 30 35 4 0.8 0.85 0.9 095  P=101.3  Mollier

Create a Psychrometric chart with wetbulb lines of 10, 15, 20, 35, 30, 35 C and specific volume lines of 0.8, 0.85, 0.90, and 0.95 m3/kg at a total pressure of 101 kPa in Mollier form.  The P=101.3 and Mollier are optional.  Note that the values of wetbulty and specific volume can be specified using previously defined variables.

 

QUIT

Close the EES application

 

Rename 'FileName1'  'FileName2'

Rename the specified file. FileName1 and FileName2 can be string variables (ending with character $) or filenames enclosed in single quotes. 

 

RenamePlot 'my Plot'   'your Plot'

If a plot window having a tab name of 'my Plot' exists, change the tab name to 'your Plot'.    Note that the names of the plot window tabs must be either string constants within single quotes or predefined EES string variables.  The plot table names are case insensitive.

 

Repeat  ,,,,,,,  Until (X-Y>5)

The commands in the macro file between the Repeat and Until keywords (which must be on separate lines) are repeated in sequence until the expression with the parentheses is true.  Each command appears on a separate line.  The parentheses are optional.  Note that any legal expression involving existing variables that are defined in the main section of the Equations window can be used in the expression.  If the expression is never true, the  macro instructions will be repeated indefinitely or until the Esc key or Macro Window stop button is pressed.  Nested Repeat-Untils are permitted.

 

Reset  a, b

Reset will reset the status of the list of variables that follow the Reset keyword  (e.g., a and b) to unassigned.  This command may be useful if a variable has previously been used in a macro command list and is now to be used in another manner in the same macro command list.

 

ResetGuesses

Reset the guess values of all variables to their default values

 

Run Program name and parameters

The Run command will start the indicated program with the given parameters, just as if this string were entered with the Run command in the Windows Start menu.  For example, to start EXCEL enter:

     Run EXCEL

You can start EXCEL and open the file C:\temp\TEST.xls with the following macro command:

     Run  c:\temp\text.xlsx 

EES knows that the .xlsx filename extension is an EXCEL file.  Using the Run command, it is possible to start external programs that read data exported by EES and then have EES import the data output by the program.  

 

Save

Save the current file with its existing file name

 

Save FileName$

Save the current file with the name provided in FileName.  FileName can be a string constant (enclosed in single quotes) or a string variable (ending with a $ character) as shown.

 

SaveArrays 'main' 'c:\myArrays.txt'  /A /T /N /E

Save the contents of the Arrays table having the tab name 'main'  to file myArrays.txt on drive C:  If ? is provided in place of the file name, a dialog will appear to enter a file name.  The following options can be applied to .TXT and .CSV files.  

If /A is provided as an option and the file exists, the current information in the table will be appended to the existing file.

If /T is provided, the data in the file will be transposed.  This option is not compatible with /E.

If /N is provided, the column name and units will be written, followed by the data in the table

If /E is provided, the file will be written in a format that can be read as a EES Lookup Table.  (Use /E /N to save all column information in an EES Lookup table). 

 

SaveIntegral 'C:\myInt.txt' /A /T /N /E

Save the contents of the Integral Table to a file called myInt.txt on drive C:  If ? is provided in place of the file name, a dialog will appear to enter a file name.  The following options can be applied to .TXT and .CSV files.

If /A is provided as an option and the file exists, the current information in the table will be appended to the existing file.

If /T is provided, the data in the file will be transposed. This option is not compatible with /E.

If /N is provided, the column name and units will be written, followed by the data in the table.

If /E is provided, the file will be written in a format that can be read as a EES Lookup Table.   (Use /E /N to save all column information in an EES Lookup table).  

 

SaveLookup 'Lookup 1' 'C:\myTable.txt'   /A /T /N /E

Save the contents of the Lookup table having the tab name 'Lookup 1' to a file named C:\mytable.txt.  If ? is provided in place of the file name, a dialog will appear to enter a file name. The following options can be applied to .TXT, .CSV and .DAT files.  They are not applicable if the saved file has an .LKT file  name extension.

If /A is provided as an option and the file exists, the current information in the table will be appended to the existing file.

If /T is provided, the data in the file will be transposed. This option is not compatible with /E.

If /N is provided, the column name and units will be written, followed by the data in the table.

If /E is provided, the file will be written with column names and units in a format that can be read as a EES Lookup Table. (Use /E /N to save all column information in an EES Lookup table). 

 

SavePlot  'my Plot'  'PlotFileName.jpg'

If a plot having a tab name of 'myPlot' exists, save the plot in a file having filename 'PlotFileName.jpg'.  Both the plot tab name and the file name may be supplied as string constants (surrounded by single quotes) or as predefined string variables (that end with a $ character).  Alternatively, the plot tab name may be indicated with an integer.  Use 0 to indicate the foremost plot.  The filename extension may be .jpg, .bmp, .tif or .emf.  EES will save the plot in the designated format.

 

SaveSolution 'mySoln.txt' /A

Save the contents of the Solution window to a file called mySoln.txt.  The /Append option will allow writing to the bottom of the file without deleting the existing information.

 

SaveTable 'Table 1' 'myTable.txt' /A /T /N /E

Save the contents of the Parametric table named 'Table 1' in the Parametric Table Window to a file called myTable.txt.  If ? is provided in place of the file name, a dialog will appear to enter a file name. The following options can be applied to .TXT, .CSV and .DAT files.  They are not applicable if the saved file has an .LKT file  name extension.

The /A option will allow writing to the bottom of the file without deleting the existing information.

If /T is provided, the data in the file will be transposed.  This option is not compatible with /E.

If /N is provided, the column name and units will be written, followed by the data in the table. 

If /E is provided, the file will be written in a format that can be read as a EES Lookup Table.  (Use /E /N to save all column information in an EES Lookup table).  

 

Serial.Close COM1

Close serial port COM1. The port name, COM1 in this example, can be a string variable, e.g., C$, that has been previously set to the port name.  If the specified serial port is not open, this command will do nothing.

 

Serial.Open  Port=COM1 Baud=9600  Parity=n  Stop=1  BufferSize=2048 TimeOut=200

Opens serial port COM1 for reading and/or writing.  The port name, COM1 in this example, can be a string variable, e.g., C$, that has been previously set to the port name.   The baud rate is the number of bits per second that data is transferred in serial communication.  Parity and Stop specify framing bits for the asynchronous communication. The baud rate, parity, and stop bits  must match the parameters of the device that EES is attempting to communicate with.  The defaults for Baud, Parity, and Stop are 9600, n, and 1.  If these parameters are not provided, the defaults are used.  Buffersize is the number of bytes used for the internal buffers for reading and writing.  The maximum buffer size is 8192.  If butfersize is set to zero or if this parameter is not provided, the default buffersize of 1024 is used.  TimeOut is the number of milleseconds that EES will wait before giving up while trying to read data from the serial port with the Serial.ReadChar Serial.ReadString, Serial. ReadNumber or  Serial.ReadtoLookup serial macro commands.   Timeout can be specified with a number or with an EES variable that has previously been set to value.  The choice for Timeout depends on the rate at which the serial device is sending data.  The Pause macro can also be used within a Repeat-Until loop to control the timing.  (See Using a Macro for Serial Port Communications)

 

Serial.ReadChar COM1 H$

Reads a single ASCII character from the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command.  An EES string variable, e.g., H$, must be provided.  The string variable will be set to the character read from the serial port.

 

Serial.ReadNumber COM1 V

Reads a numerical value (integer or real) from the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command.  An EES variable, e.g., V, must be provided.  The value of the variable will be set to the numerical value read from the serial port.  Note that the numerical value is provided to the serial port by the external program as a string of numerical characters terminated by CRLF, i.e., carriage return (ASCII13) and line feed (ASCII 10) characters.  The ReadNumber macro command will continue to look for the number on the serial port until it reads a CRLF or the Timeout interval specified in the Serial.Open command is exceeded.

 

Serial.ReadString COM1 S$ 

Reads a string consisting a one or more ASCII characters from the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command.  An EES string variable, e.g., S$, must be provided.   The string variable will be set to the character string read from the serial port.  Note that string provided to the serial port by the external program must be terminated by CRLF, i.e., carriage return (ASCII13) and line feed (ASCII 10) characters.  The ReadString macro command will continue to look for the string on the serial port until it reads a CRLF or the Timeout interval specified in the Serial.Open command is exceeded.

 

Serial.ReadtoLookup COM1 'TableName'  Row Col

Reads a numerical value from the specified serial port directly into a specified cell of a specified Lookup table.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name.  The specified port must have been previously opened with the Serial.Open command.  The second parameter, TableName, is the name of the Lookup table that appears on the tab of the Lookup table.  TableName can be either a string constant or string variable.  The Lookup table must exist.  It can be created using the New Lookup Table menu or the NewLookup macro command.  Row and Col are respectively, the row and column in which the numerical value will be placed after the read operation is completed.  Row and Col can be provided as numerical values or as EES variables that have been previously set to numerical values.  The column can also be indicated by providing the column name as a string constant.  If Row is greater than the number of rows in the table, the number of rows is increased.  However, this operation takes time and may result in lost data.  It is better to use the InserLookupRows macro command to ensure that there are sufficient rows in the designated lookup table.  If Col is greater than the number of columns in the table, the value will be ignored.  Note that the numerical value is provided to the serial port by the external program as a string of numerical characters forming a single numerical value terminated by CRLF, i.e., carriage return (ASCII13) and line feed (ASCII 10) characters.  The ReadtoLookup macro command will continue to look for the number on the serial port until it reads a CRLF or the Timeout interval specified in the Serial.Open command is exceeded.

 

Serial.WriteChar COM1 'H'

Writes one or more ASCII characters to the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command. The second parameter is a string constant (enclosed within single quotes) or an EES string variable containing the character(s) that are to be written. Note that this command differs from the Serial.WriteString command in that CRLF (carriage return line feed characters) are not written to the serial port.

 

Serial.WriteNumber COM1 V

Writes the ASCII characters representing a number to the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command. The second parameter is either the numerical value or an EES variable, e.g., V, containing the numerical value that is to be written. CRLF (carriage return line feed characters) are appended to the number that is written to the serial port.

 

Serial.WriteString COM1 S$

Writes one or more ASCII characters to the specified serial port.  The first parameter is the port name, COM1 in this example, and it can be a string variable, e.g., C$, that has been previously set to the port name. The specified port must have been previously opened with the Serial.Open command. The second parameter is a numerical value or an EES string containing the character(s) that are to be written. Note that this command differs from the Serial.WriteChar command in that CRLF (carriage return line feed characters) are appended to the characters that are written to the serial port.

 

SetDirectory(F$)

SetDirectory(F$) will set the current Windows directory to the string constant or string variable within the parentheses.

 

ShowWindow Arrays

Bring the Arrays table the front

 

ShowWindow Diagram 'Name'

Bring the Diagram window to the front.  The name of a child Diagram window can be optionally provided as a string constant (within single quotes) or a string variable.  If no name is provided, the main diagram window will be shown.

 

ShowWindow EES

If the EES application is minimized or hidden, this macro command will cause it to be visible.

 

ShowWindow Equations

Bring the Equations window to the front

 

ShowWindow ErrorMessages

Normally, error message (including those generated by the Call Error procedure) are quietly written to the Macro log file rather than shown on the screen.  However, this macro command will cause the error messages to be displayed in the same way they would appear if they were run as a normal EES program.  

 

ShowWindow Format

Bring the Formatted Equations window to the front

 

ShowWindow Integrals

Bring the Integrals table the front

 

ShowWindow Lookup 'Table Name'

Bring the Lookuptable to the front.  The name of the Lookup table can be optionally provided as a string constant (within single quotes) or a string variable in which case the table having this name on its tab will be selected. 

 

ShowWindow Parametric 'Table Name'

Bring the Parametric table to the front.  The name of the Parametric table can be optionally provided as a string constant (within single quotes) or a string variable in which case the table having this name on its tab will be selected.

 

ShowWindow Plot 'Plot Name'

Bring the plot to the front.  The name of the plot can be optionally provided as a string constant (within single quotes) or a string variable in which case the plot window having this name on its tab will be selected.  Plot Name can also be an integer indicating the position of the plot tab from the left, e.g., Show Plot 2.

 

ShowWindow Progress

Normally, a series of EES commands initiated from a macro command list will not show the Progress window.  However, if the macro has been started from the Calculate button in the Diagram window, it may be desirable to show the Progress window to reassure the user that the calculations are proceeding  in a long calculation.  Including this macro command will ensure that the Progress window is visible.

 

ShowWindow Residuals

Bring the Residuals window to the front

 

ShowWindow Solution 'Name'

Bring the Solutions window to the front.  The name of a tab in the Solutions window can be optionally provided as a string constant (within single quotes) or a string variable in which case the solution window having this name on its tab will be shown.  Setting Name to 'Key' will display the Key variables window if it exists.  The main solution window has name 'Main'. 

 

Solve

Solve as if the Solve command has been issued

 

SolveTable /S /U /R 'Table 1' Rows=1..10

Solve rows 1 through 10 of the Parametric Table having the name 'Table 1'.  If no range is specified, all rows are solved.  The start and stop row numbers may be specified with variables that have been previously defined, e.g., SolveTable 'Table 1' Rows=Start..Stop.  If /S is provided the calculations will stop if an error is encountered and remaining rows of the table will not be processed.  If /U is provided, the guess values will be updated after each row of the table sucessfully completes calculations.  If /R is provided the calculations will be start on the last row and proceed to the first row of the specified range.

 

Stop

Execution of the Stop macro command will immediately stop the macro.

 

StopCrit  It=100  Time=3600  Res= 1.0E-0006  Var= 1.0E-0006

Set the Stop Criteria properties as indicated

 

TabStops 0.25 0.5 2 4 in

TabStops sets tab stops in the Macro window measured in inches (in) or centimeters (cm).  Tab stops can also be set by right-clicking the mouse in the Macro window.

 

Uncertainty  h, Q, T_s=A1.5, Vel=R0.01 T_inf=Au_Tinf

Initiate the Uncertainty Propagation calculations to determine the uncertainty in variables h and Q as a result of uncertainties in variables T_s, Vel and T_infinity.  Note that measured values are identified with an =A or =R following their name.  In this example, the uncertainty in variable T_s is 1.5 on an absolute (A) basis.  The uncertainty in variable Vel is 0.01 of its current value (relative basis).  The absolute uncertainty in variable T_inf is equal to the value of variable u_Tinf, which must be set to a constant in the Equations window.  Note that the designation Ru_Tinf would set the uncertainty of variable T_inf in a relative manner so that its uncertainty would be the product of its current value and the value of u_Tinf.

 

UncertaintyTable /S /U /R 'Table 1' Rows=1..10  h, Q, T_s=A1, Vel=R0.01 T_inf=Au_Tinf

Initiate the UncertaintyTable calculations to determine the uncertainty in variables h and Q as a result of uncertainties in variables T_s, Vel, and T_inf. Measured variables (here T_s, Vel and T_inf) are identified with =A or =R following their names. A indicates absolute uncertainty and R indicates relative uncertainty.  The absolute or relative uncertainty is indicated with a numerical value or with a variable name following the A or R.  Note that if a variable is name is indicated, the variable must be set to a value in the Equations window or in the Parametric table.  Variables without an = following their name are assumed to be calculated values.   All of the variables should be in the specified Parametric Table.  If /U is provided, the guess values will be updated after each row of the table sucessfully completes calculations.  If /R is provided the calculations will be start on the last row and proceed to the first row of the specified range.  If /S is provided the calculations will stop if an error is encountered and remaining rows of the table will not be processed.

 

Units C kPa MASS DEG

Set the Units as indicated.  Mixed units, e.g., C and psia, are not supported.

 

UpdateGuesses

Update the guess values of all variables to the last set of calculated values

 

VarInfo  P2   Lower=200 Upper=500 Guess=300  Units='kPa'  AltUnits='psia' Display=F1 Style=Bold Key='pressure''

Set the lower bound, upper bound, guess, units, alternate units and display for variable P2 as specified

 

WORD.FileNew

Start WORD and create a new empty document.

 

WORD.FileOpen('FileName')

Start WORD and open the specified Word file.  It is necessary to provide the complete file name.

 

WORD.FileSaveAs('FileName')

Save the current WORD document with the specified filename.

 

WORD.Hide

Hide the open WORD document.

 

WORD.Insert('any text here')

Insert the text contained with single quotes into the WORD document at the current position.

 

WORD.Paste

Paste the current contents of the Clipboard into WORD.

 

WORD.PasteSpecial(formatType)

Paste the current contents of the Clipboard into WORD in the specified format.  The formatType can be TEXT, PICTURE, BITMAP, DEVICE INDEPENDENT BITMAP, and ENHANCED METAFILE.

 

WORD.Quit

Close the communication with WORD.

 

WORD.Show

Make the open WORD document visible.

 

 

Note that any of the commands can be sent directly from an external program to EES with the application's DDEExecute command.  For example, the following command issued from EXCEL Visual Basic will cause EES to execute its SOLVETABLE command for Table 1.  Note that when macro commands must be enclosed in square brackets.

 

Application.DDEExecute ChannelNumber, "[SOLVETABLE 'TABLE 1', Rows=1..10]"