Difference between revisions of "CAEngine"

(descriptions)
Line 15: Line 15:
 
== VBScript ==
 
== VBScript ==
  
==Properties==
+
=Properties=
* {get,put} string [[CAEngine::Command|Command]]
+
 
* {get,put} CAObject [[CAEngine::CurrentModule|CurrentModule]]
+
=== {get,put} string [[CAEngine::Command|Command]] ===
* {get,put} [[CARenderingStyle]] [[CAEngine::DefaultDefTableRenderingStyle|DefaultDefTableRenderingStyle]]
+
 
* {get,put} [[CARenderingStyle]] [[CAEngine::DefaultRenderingStyle|DefaultRenderingStyle]]
+
Holds a typescript command that gets executed when the [[CAEngine::Send|Send]]() method is called.
* {get} short int [[CAEngine::ErrorCode|ErrorCode]]
+
 
* {get} string [[CAEngine::ErrorText|ErrorText]]
+
=== {get,put} CAObject [[CAEngine::CurrentModule|CurrentModule]] ===
* {get} string [[CAEngine::Log|Log]]
+
 
* {get} string [[CAEngine::OutputBuffer|OutputBuffer]]
+
Newly created objects are placed into [[CurrentModule]]; so, you should set [[CurrentModule]] before
* {get,put} bool [[CAEngine::Photo|Photo]]
+
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} [[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==
 
==Methods==

Revision as of 19:51, 1 August 2009

class CAEngine (ADE)

In-Process and Out-of-Process Instantiations

Creation

C#

Visual Basic.NET

C++

VBScript

Properties

{get,put} string Command

Holds a typescript command that gets executed when the Send() method is called.

{get,put} CAObject CurrentModule

Newly created objects are placed into CurrentModule; so, you should set CurrentModule before creating any new objects. Setting CurrentModule = Nothing 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 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} CARenderingStyle 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 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 ErrorText

Short text explanation of error from ErrorCode.

{get} string 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 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 Photo

When Photo is True, ADE records all typescript commands and results into the Log property.

Methods

Comments


You are not allowed to post comments.