Difference between revisions of "Analytica Decision Engine (ADE) API"
(CARenderingStyle methods) |
m (shorted methods / properties in CAEngine) |
||
| Line 2: | Line 2: | ||
==Creation== | ==Creation== | ||
==Properties== | ==Properties== | ||
| − | |||
* {get,put} string [[CAEngine::Command|Command]] | * {get,put} string [[CAEngine::Command|Command]] | ||
* {get,put} CAObject [[CAEngine::CurrentModule|CurrentModule]] | * {get,put} CAObject [[CAEngine::CurrentModule|CurrentModule]] | ||
| + | * {get,put} [[CARenderingStyle]] [[CAEngine::DefaultDefTableRenderingStyle|DefaultDefTableRenderingStyle]] | ||
| + | * {get,put} [[CARenderingStyle]] [[CAEngine::DefaultRenderingStyle|DefaultRenderingStyle]] | ||
* {get} short int [[CAEngine::ErrorCode|ErrorCode]] | * {get} short int [[CAEngine::ErrorCode|ErrorCode]] | ||
| + | * {get} string [[CAEngine::ErrorText|ErrorText]] | ||
* {get} string [[CAEngine::Log|Log]] | * {get} string [[CAEngine::Log|Log]] | ||
| + | * {get} string [[CAEngine::OutputBuffer|OutputBuffer]] | ||
* {get,put} bool [[CAEngine::Photo|Photo]] | * {get,put} bool [[CAEngine::Photo|Photo]] | ||
| − | |||
| − | |||
| − | |||
==Methods== | ==Methods== | ||
| Line 16: | Line 16: | ||
* bool [[CAEngine::CloseModel|CloseModel]]() | * bool [[CAEngine::CloseModel|CloseModel]]() | ||
* [[CAObject]] [[CAEngine::CreateObject|CreateObject]](string objName, string objType) | * [[CAObject]] [[CAEngine::CreateObject|CreateObject]](string objName, string objType) | ||
| + | * bool [[CAEngine::CreateModel|CreateModel]](string newModelName) | ||
* bool [[CAEngine::DeleteObject|DeleteObject]]( [[CAObject]] aObject ) | * bool [[CAEngine::DeleteObject|DeleteObject]]( [[CAObject]] aObject ) | ||
| + | * [[CAObject]] [[CAEngine::Get|Get]](string objName) | ||
* [[CAObject]] [[CAEngine::GetObjectByName|GetObjectByName]](string objName) | * [[CAObject]] [[CAEngine::GetObjectByName|GetObjectByName]](string objName) | ||
| − | |||
| − | |||
* string [[CAEngine::OpenModel|OpenModel]](string filepath) | * string [[CAEngine::OpenModel|OpenModel]](string filepath) | ||
| + | * bool [[CAEngine::ReadScript|ReadScript]](string filePath) | ||
* void [[CAEngine::ResetError|ResetError]]() | * void [[CAEngine::ResetError|ResetError]]() | ||
| − | |||
* bool [[CAEngine::SaveModel|SaveModel]](string filePath) | * bool [[CAEngine::SaveModel|SaveModel]](string filePath) | ||
* bool [[CAEngine::SaveModuleFile|SaveModuleFile]](string moduleName, string filePath) | * bool [[CAEngine::SaveModuleFile|SaveModuleFile]](string moduleName, string filePath) | ||
Revision as of 17:06, 1 August 2009
CAEngine
Creation
Properties
- {get,put} string Command
- {get,put} CAObject CurrentModule
- {get,put} CARenderingStyle DefaultDefTableRenderingStyle
- {get,put} CARenderingStyle DefaultRenderingStyle
- {get} short int ErrorCode
- {get} string ErrorText
- {get} string Log
- {get} string OutputBuffer
- {get,put} bool Photo
Methods
- string AddModule(string filePath,bool Merge)
- bool CloseModel()
- CAObject CreateObject(string objName, string objType)
- bool CreateModel(string newModelName)
- bool DeleteObject( CAObject aObject )
- CAObject Get(string objName)
- CAObject GetObjectByName(string objName)
- string OpenModel(string filepath)
- bool ReadScript(string filePath)
- void ResetError()
- 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
- {get,put} int GraphHeight
- {get,put} int GraphWidth
- {get} variant IndexNames
- {get,put} string Name
- {get} short int NumDims
- {get,put} CARenderingStyle RenderingStyle
- {get,put} short int ResultType
- {get,put} string TableType
Methods
- variant AtomicValue()
- variant GetDataByElements(variant indexPtrs)
- variant GetDataByLabels(variant indexLabels)
- CAIndex GetIndexObject(string indexName)
- variant GetSafeArray()
- bool GraphToFile(string fileName, string mimeType)
- bool GraphToStream(IStream stream, string mimeType)
- string IndexName(short int indexNum)
- bool ObtainTable()
- bool PutSafeArray(variant theVal)
- bool SetDataByElements(variant elementValue, variant indexPtrs)
- bool SetDataByLabels(variant elementValue, variant indexLabels)
- bool SetIndexOrder(SAFEARRAY<string> indexArray)
- CATable Slice(CAIndex index, int i)
- CATable Subscript(CAIndex index, variant label)
- bool Update()
CAIndex
Creation
Properties
- {get} long IndexElements
- {get,put} string Name
- {get,put} CARenderingStyle RenderingStyle
Methods
- long GetNumberByValue(variant val)
- variant GetValueByNumber(long i)
- bool ObtainIndex(string indName)
CARenderingStyle
Creation
Properties
- {get,put} bool FullPrecision
- {get,put} bool GeneralExpression
- {get,put} short HandleFormat
- {get,put} bool NewLineAsCRLF
- {get,put} variant NullValue
- {get,put} bool NumberAsText
- {get,put} bool ReferenceAsText
- {get,put} long SafeArrayLowerBound
- {get,put} short StringQuotes
- {get,put} variant UndefValue
- {get,put} short VarTermFormat
Methods
none
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