Difference between revisions of "Analytica Decision Engine (ADE) API"
(Listed methods of CAEngine & CALicense) |
(CAObject properties and methods) |
||
| Line 30: | Line 30: | ||
= [[CAObject]] = | = [[CAObject]] = | ||
==Creation== | ==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== | ==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== | ==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]] = | = [[CATable]] = | ||
Revision as of 16:44, 1 August 2009
CAEngine
Creation
Properties
- {get} string ErrorText
- {get,put} string Command
- {get,put} CAObject CurrentModule
- {get} short int ErrorCode
- {get} string Log
- {get,put} bool Photo
- {get} string OutputBuffer
- {get,put} CARenderingStyle DefaultDefTableRenderingStyle
- {get,put} CARenderingStyle DefaultRenderingStyle
Methods
- string AddModule(string filePath,bool Merge)
- bool CloseModel()
- CAObject CreateObject(string objName, string objType)
- bool DeleteObject( CAObject aObject )
- CAObject GetObjectByName(string objName)
- CAObject Get(string objName)
- bool CreateModel(string newModelName)
- string OpenModel(string filepath)
- void ResetError()
- bool ReadScript(string filePath)
- bool SaveModel(string filePath)
- bool SaveModuleFile(string moduleName, string filePath)
- bool Send()
- bool 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 ClassType
- {get,put} string Name
- {get,put} short int ResultType
- {get,put} CARenderingStyle RenderingStyle
- {get,put} long MethodEvaluationTimeLimit
- {get} short int DefinitionType
Methods
- bool CreateDefTable(SAFEARRAY indexArray)
- CATable DefTable()
- variant GetAttribute(string attName)
- bool SetAttribute(string attName, variant attValue)
- variant Result()
- CATable ResultTable()
- CATable Evaluate(string expression)
- bool PictureToStream(IStream stream, string mimeType)
- bool PictureToFile(string fileName, string mimeType)
CATable
Creation
Properties
Methods
CAIndex
Creation
Properties
Methods
CARenderingStyle
Creation
Properties
Methods
CALicense
Creation
Properties
- {get} string ErrorText
- {get} short int ErrorCode
- {get} long AvailableLicenseInstances
- {get} long MaxLicenseInstances
- {get} BOOL MaxLicenseInstances
Methods
- CAEngine NewCAEngine()
- void SetApplicationLicenseCode(string)
Comments
Enable comment auto-refresher