View source for CAEngine

[[Category:ADE Classes]]
<< [[Analytica Decision Engine (ADE) API]]

= class CAEngine  (ADE) =

= In-Process and Out-of-Process Instantiations =

= Creation =

=== C# ===

=== Visual Basic.NET ===

=== C++ ===

=== VBScript ===

=Properties=

=== {get,put} string [[CAEngine::Command|Command]] ===

Holds a typescript command that gets executed when the [[CAEngine::Send|Send]]() method is called.

=== {get,put} [[CAObject]] [[CAEngine::CurrentModule|CurrentModule]] ===

Newly created objects are placed into [[CurrentModule]]; so, you should set [[CurrentModule]] before
creating any new objects. Setting <code>[[CurrentModule]] = Nothing</code> means that no module is open,
so all new objects are created in the top-level Module or Model of the currently opened model.

=== {get,put} [[CARenderingStyle]] [[CAEngine::DefaultDefTableRenderingStyle|DefaultDefTableRenderingStyle]] ===

The default rendering style controlling how definition table values are transferred to and from
ADE. All definition tables returned from [[CAObject::DefTable]] inherits these settings when they
are first created.

=== {get,put} long [[CAEngine::DefaultEvaluationTimeLimit|DefaultEvaluationTimeLimit]] ===

''new to ADE 4.3''

The maximum time limit in milliseconds imposed on evaluations from methods in [[CAEngine]], i.e., [[CAEngine::SendCommand|SendCommand]], [[CAEngine::Send|Send]], [[CAEngine::OpenModel|OpenModel]], and [[CAEngine::AddModule|AddModule]], as well as the default value for [[CAObject::MethodEvaluationTimeLimit]] for any [[CAObject]]s instantiated.  A value of zero indicates no time limit.

=== {get,put} [[CARenderingStyle]] [[CAEngine::DefaultRenderingStyle|DefaultRenderingStyle]] ===

The default rendering style controlling how result values are returned from ADE. All [[CAObject]]
instances inherit this rendering style when they are created.

=== {get} short int [[CAEngine::ErrorCode|ErrorCode]] ===

Returns the error code generated by the last communication with the Analytica Decision Engine
Server. The property [[ErrorCode]] should be checked after setting and retrieving critical [[CAEngine]]
properties and calling CAEngine methods. An ErrorCode of zero indicates the last action was
successful.

=== {get} string [[CAEngine::ErrorText|ErrorText]] ===

Short text explanation of error from [[ErrorCode]].

=== {get} string [[CAEngine::Log|Log]] ===

A record of all commands sent to the ADE typescript and the results received from those commands,
when the Photo property is true.

=== {get} string [[CAEngine::OutputBuffer|OutputBuffer]] ===

A text string buffer that contains the result of the last typescript (i.e., using the Command property
and Send method) interaction with the ADE.

=== {get,put} bool [[CAEngine::Photo|Photo]] ===

When '''Photo''' is True, ADE records all typescript commands and results into the [[CAEngine::Log|Log]] property.

=Methods=

=== string [[CAEngine::AddModule|AddModule]](string filePath,bool Merge) ===

Adds a module from file fileName into the CurrentModule. The merge parameter currently has
no effect and should be set to True.

=== bool [[CAEngine::CloseModel|CloseModel]]() ===

Closes the model.

=== [[CAObject]] [[CAEngine::CreateObject|CreateObject]](string objName, string objType) ===

Creates a new Analytica object with identifier objName and class objClass in the CurrentModule
and returns it as a CAObject.

=== bool [[CAEngine::CreateModel|CreateModel]](string newModelName) ===

Creates a new Analytica model with identifier modelName.

=== bool [[CAEngine::DeleteObject|DeleteObject]]( [[CAObject]] aObject ) ===

Deletes CAObject obj from the current model.

=== [[CAObject]] [[CAEngine::Get|Get]](string objName) ===

Synonymous with [[CAEngine::GetObjectByName|GetObjectByName]].

=== [[CAObject]] [[CAEngine::GetObjectByName|GetObjectByName]](string objName) ===

Returns an object of type [[CAObject]] for an existing Analytica object with identifier objName.

=== bool [[CAEngine::MonitorProcess|MonitorProcess]](long pid) ===

''(requires ADE 4.3 or greater)'' Instructs ADE to terminate (kill itself) if the indicated process terminates before it.  Useful when debugging code that uses ADE to prevent zombie ADE processes when your code is terminated prematurely without having a chance to correctly release its objects.

=== string [[CAEngine::OpenModel|OpenModel]](string filepath) ===

Reads a model from a disk file and opens it as the current model.

=== bool [[CAEngine::ReadScript|ReadScript]](string filePath) ===

Reads and executes an Analytica script file.

=== void [[CAEngine::ResetError|ResetError]]() ===

Resets the error code, error text string associated with the error code, and the output buffer to
default values. This function is normally used internally, but could be useful in other circumstances
as well.

=== bool [[CAEngine::SaveModel|SaveModel]](string filePath) ===

Saves the model to file «filePath».

=== bool [[CAEngine::SaveModuleFile|SaveModuleFile]](string moduleName, string filePath) ===

Saves module with identifier «moduleName» into file «filePath».

=== bool [[CAEngine::Send|Send]]() ===

Sends the string contained in the Command property as a command to be executed by ADE.
See the Analytica Scripting Guide for details of commands and syntax.

=== bool [[CAEngine::SendCommand|SendCommand]](string command) ===

Sends the string command property as a typescript command to be executed by ADE. See the
Analytica Scripting Guide for details of commands and syntax.

=== bool [[CAEngine::SetCallbackObject|SetCallbackObject]](IUnknown* pCallbackObj) ===

''New to [[What's new in Analytica 4.3?|ADE 4.3]]''

Provides an object that implements various callback interfaces, such as [[IAMsgBoxCallback]], to enable interaction with end-users while evaluation is in-progress.