LISp-Miner Control Language Reference, version: 27.13.01 of 25 Aug 2017

Namespace lm

Base namespace for LISp-Miner related classes and functions

Classes List

LMWrap  An abstract Lua wrapper for LISp-Miner metabase objects
LMWrapName  An abstract class for wrapped LM objects with Name and Note

Properties List

ScriptParam  Parameters passed to LMExec with /ScriptParam and identified by its name

Functions List

getLMRootDirectory () Returns LISp-Miner root folder
getLMRootFolder () Returns LISp-Miner root folder
getLogVerbosityLevel () Returns how much of the execution logged into history, see LogVerbosityLevel codes
getOSCurrentDirectory () Returns operating system current working folder
getOSCurrentFolder () Returns operating system current working folder
getScriptDirectory () Returns The folder containing currently opened script
getScriptFolder () Returns The folder containing currently opened script
isLogFunctionParameterValuesFlag () Returns TRUE if parameter values passed to functions are logged
log () Writes given string to log history. An optional integer parameter could be provided to set the log verbosity level of this message.
logEmptyLine () Writes an empty line to log history. An optional integer parameter could be provided to set the log verbosity level of this message.
logError () Writes given string to log history, pop-ups an error box and terminates the script execution
logIndentDown () Returns the log line indent one notch left
logIndentUp () Indents all the next log lines one notch right. If a string is passed it is logged during indent up and once again during indent down to visually identify the end of this indent group
logInfo () Writes given string to log history and pop-ups an dialog box
logVersion () Writes information about the current version of LM and Lua to log history
logWarning () Writes given string to log history and pop-ups an dialog box with option to break execution
setIsLogFunctionParameterValues () Sets the value of the LogFunctionParameterValues flag, ie. whether to log parameter values passed to functions
setLogFunctionParameterValuesFlag () Sets the value of the LogFunctionParameterValues flag, ie. whether to log parameter values passed to functions. Returns the previous value so it could restore later.
setLogVerbosityLevel () How much of the execution logged into history. Returns the previous value so it could restore later.
setOSCurrentDirectory () Sets operating system current working folder
setOSCurrentFolder () Sets operating system current working folder
sleep () Suspends the thread for given number of milliseconds by calling the OS sleep function

Properties

ScriptParam  (read-only) : table
Parameters passed to LMExec with /ScriptParam and identified by its name

Functions

getLMRootDirectory() : string
Returns LISp-Miner root folder

Returns

  • string
getLMRootFolder() : string
Returns LISp-Miner root folder

Returns

  • string
getLogVerbosityLevel() : integer
Returns how much of the execution logged into history, see LogVerbosityLevel codes

Returns

  • integer
getOSCurrentDirectory() : string
Returns operating system current working folder

Returns

  • string
getOSCurrentFolder() : string
Returns operating system current working folder

Returns

  • string
getScriptDirectory() : string
Returns The folder containing currently opened script

Returns

  • string
getScriptFolder() : string
Returns The folder containing currently opened script

Returns

  • string
isLogFunctionParameterValuesFlag() : boolean
Returns TRUE if parameter values passed to functions are logged

Returns

  • boolean
log( string )
Writes given string to log history. An optional integer parameter could be provided to set the log verbosity level of this message.

Parameters

  • string - string to be logged
logEmptyLine()
Writes an empty line to log history. An optional integer parameter could be provided to set the log verbosity level of this message.
logError( string )
Writes given string to log history, pop-ups an error box and terminates the script execution

Parameters

  • string - string to be logged
logIndentDown()
Returns the log line indent one notch left
logIndentUp( string )
Indents all the next log lines one notch right. If a string is passed it is logged during indent up and once again during indent down to visually identify the end of this indent group

Parameters

  • string - string to be logged (optional)
logInfo( string )
Writes given string to log history and pop-ups an dialog box

Parameters

  • string - string to be logged
logVersion()
Writes information about the current version of LM and Lua to log history
logWarning( string )
Writes given string to log history and pop-ups an dialog box with option to break execution

Parameters

  • string - string to be logged
setIsLogFunctionParameterValues( boolean )
Sets the value of the LogFunctionParameterValues flag, ie. whether to log parameter values passed to functions

Parameters

  • boolean
setLogFunctionParameterValuesFlag( boolean )
Sets the value of the LogFunctionParameterValues flag, ie. whether to log parameter values passed to functions. Returns the previous value so it could restore later.

Parameters

  • boolean
setLogVerbosityLevel( integer )
How much of the execution logged into history. Returns the previous value so it could restore later.

Parameters

setOSCurrentDirectory( string )
Sets operating system current working folder

Parameters

  • string
setOSCurrentFolder( string )
Sets operating system current working folder

Parameters

  • string
sleep( integer )
Suspends the thread for given number of milliseconds by calling the OS sleep function

Parameters

  • integer - number of milliseconds