Analytica Decision Engine (ADE) API

CAEngine

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

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

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

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

Properties

• {get} string ErrorText
• {get} short int ErrorCode
• {get} long AvailableLicenseInstances
• {get} long MaxLicenseInstances
• {get} BOOL MaxLicenseInstances

Methods

• CAEngine NewCAEngine()
• void SetApplicationLicenseCode(string)