Difference between revisions of "Analytica Decision Engine (ADE) API"

(CAObject properties and methods)
(Redirected page to ADE Server Class Reference)
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
= [[CAEngine]] =
+
#REDIRECT [[ADE Server Class Reference]]
==Creation==
 
==Properties==
 
* {get} string [[CAEngine::ErrorText|ErrorText]]
 
* {get,put} string [[CAEngine::Command|Command]]
 
* {get,put} CAObject [[CAEngine::CurrentModule|CurrentModule]]
 
* {get} short int [[CAEngine::ErrorCode|ErrorCode]]
 
* {get} string [[CAEngine::Log|Log]]
 
* {get,put} bool [[CAEngine::Photo|Photo]]
 
* {get} string [[CAEngine::OutputBuffer|OutputBuffer]]
 
* {get,put} [[CARenderingStyle]] [[CAEngine::DefaultDefTableRenderingStyle|DefaultDefTableRenderingStyle]]
 
* {get,put} [[CARenderingStyle]] [[CAEngine::DefaultRenderingStyle|DefaultRenderingStyle]]
 
 
 
==Methods==
 
* string [[CAEngine::AddModule|AddModule]](string filePath,bool Merge)
 
* bool [[CAEngine::CloseModel|CloseModel]]()
 
* [[CAObject]] [[CAEngine::CreateObject|CreateObject]](string objName, string objType)
 
* bool [[CAEngine::DeleteObject|DeleteObject]]( [[CAObject]] aObject )
 
* [[CAObject]] [[CAEngine::GetObjectByName|GetObjectByName]](string objName)
 
* [[CAObject]] [[CAEngine::Get|Get]](string objName)
 
* bool [[CAEngine::CreateModel|CreateModel]](string newModelName)
 
* string [[CAEngine::OpenModel|OpenModel]](string filepath)
 
* void [[CAEngine::ResetError|ResetError]]()
 
* bool [[CAEngine::ReadScript|ReadScript]](string filePath)
 
* bool [[CAEngine::SaveModel|SaveModel]](string filePath)
 
* bool [[CAEngine::SaveModuleFile|SaveModuleFile]](string moduleName, string filePath)
 
* bool [[CAEngine::Send|Send]]()
 
* bool [[CAEngine::SendCommand|SendCommand]](string command)
 
 
 
= [[CAObject]] =
 
==Creation==
 
 
 
A [[CAObject]] instances cannot be created directly.  You must obtain a [[CAObject]] as the return results of other methods.  The most common method used to obtain a [[CAObject]] is [[CAEngine::GetObjectByName]] (or its synonym, [[CAEngine::Get]]). 
 
 
 
==Properties==
 
* {get,put} string [[CAObject::ClassType|ClassType]]
 
* {get,put} string [[CAObject::Name|Name]]
 
* {get,put} short int [[CAObject::ResultType|ResultType]]
 
* {get,put} [[CARenderingStyle]] [[CAObject::RenderingStyle|RenderingStyle]]
 
* {get,put} long [[CAObject::MethodEvaluationTimeLimit|MethodEvaluationTimeLimit]]
 
* {get} short int [[CAObject::DefinitionType|DefinitionType]]
 
 
 
==Methods==
 
 
 
* bool [[CAObject::CreateDefTable|CreateDefTable]](SAFEARRAY indexArray)
 
* [[CATable]] [[CAObject::DefTable|DefTable]]()
 
* variant [[CAObject::GetAttribute|GetAttribute]](string attName)
 
* bool [[CAObject::SetAttribute|SetAttribute]](string attName, variant attValue)
 
* variant [[CAObject::Result|Result]]()
 
* [[CATable]] [[CAObject::ResultTable|ResultTable]]()
 
* [[CATable]] [[CAObject::Evaluate|Evaluate]](string expression)
 
* bool [[CAObject::PictureToStream|PictureToStream]](IStream stream, string mimeType)
 
* bool [[CAObject::PictureToFile|PictureToFile]](string fileName, string mimeType)
 
 
 
= [[CATable]] =
 
==Creation==
 
==Properties==
 
==Methods==
 
 
 
= [[CAIndex]] =
 
==Creation==
 
==Properties==
 
==Methods==
 
 
 
= [[CARenderingStyle]] =
 
==Creation==
 
==Properties==
 
==Methods==
 
 
 
= [[CALicense]] =
 
==Creation==
 
==Properties==
 
* {get} string [[CALicense::ErrorText|ErrorText]]
 
* {get} short int [[CALicense::ErrorCode|ErrorCode]]
 
* {get} long [[CALicense::AvailableLicenseInstances|AvailableLicenseInstances]]
 
* {get} long [[CALicense::MaxLicenseInstances|MaxLicenseInstances]]
 
* {get} BOOL [[CALicense::CanUseOptimizer|MaxLicenseInstances]]
 
 
 
==Methods==
 
* [[CAEngine]] [[CALicense::NewCAEngine|NewCAEngine]]()
 
* void [[CALicense::SetApplicationLicenseCode|SetApplicationLicenseCode]](string)
 

Latest revision as of 02:49, 2 June 2015

Comments


You are not allowed to post comments.