Difference between revisions of "CAObject::ResultTable"
(Created page with "<< class CAObject = Description = This method of CAObject evaluates the result and returns a CATable object. The CAObject::ResultType property control...") |
(Marked this version for translation) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[CAObject | + | [[Category:ADE User Guide]] |
| + | [[ADE User Guide]] > [[ADE Server Class Reference]] > [[CAObject]] | ||
| + | <languages /> | ||
| + | <translate> | ||
| + | = Description = <!--T:1--> | ||
| − | + | <!--T:2--> | |
| + | Returns the result of evaluating a variable as a [[CATable]] object, with zero or more dimensions, or '''Nothing''' if the variable object cannot be evaluated. A [[CATable]] is a representation of an intelligent (multi-dimensional) array, and various methods of that object are used to access the cell data. If the result is a scalar (i.e., not an array), the [[CATable]] is zero-dimensional. | ||
| − | + | <!--T:3--> | |
| + | The [[CAObject::ResultType]] property controls which result is computed ([[Mid]], [[Sample]], [[Mean]], [[Statistics]], [[ProbBands|Bands]], [[PDF]] or [[CDF]]). | ||
| − | + | <!--T:4--> | |
| + | If the variable has not yet been evaluated, it is evaluated when this method is called. If this requires a lengthy calculation, the call will take a long time to complete. When [[CAObject::MethodEvaluationTimeLimit]] is set, then the result aborts if the time limit expires and [[CAEngine::ErrorCode|ErrorCode]] is 77. | ||
| + | <!--T:5--> | ||
| + | If an error occurs during evaluation, the [[CAEngine::ErrorCode|ErrorCode]] will be set to something other than 0 or 2. If a warning occurs during evaluation, a result will be returned and the [[CAEngine::ErrorCode|ErrorCode]] will be 2. The [[CAEngine::OutputBuffer|OutputBuffer]] contains the error message or warning. | ||
| + | |||
| + | = Data type = <!--T:6--> | ||
| + | |||
| + | <!--T:7--> | ||
[[CATable]] | [[CATable]] | ||
| − | = Example Usage = | + | = Example Usage = <!--T:8--> |
| − | [[CATable]] tab = obj.ResultTable; | + | <!--T:9--> |
| + | [[CATable]] tab = obj.ResultTable; | ||
| − | = [[ErrorCode]]s = | + | = [[ErrorCode]]s = <!--T:10--> |
| − | + | <!--T:11--> | |
| + | ''This list is incomplete -- TBD'' | ||
| + | : 0 - success | ||
| + | : 2 - warning | ||
| + | : 12 - insufficient memory | ||
| + | : 37,38 - Could not retrieve result | ||
| + | : 77 - [[CAObject::MethodEvaluationTimeLimit|MethodEvaluationTimeLimit]] exceeded | ||
| + | : 78 - Computation aborted | ||
| − | = See Also = | + | = See Also = <!--T:12--> |
| + | <!--T:13--> | ||
* [[CAObject::Result]] | * [[CAObject::Result]] | ||
| + | * [[CAObject::Evaluate]] | ||
| + | * [[CATable]] | ||
* [[CATable::Subscript]], [[CATable::Slice]] | * [[CATable::Subscript]], [[CATable::Slice]] | ||
| + | * [[CAObject]], [[CATable]] | ||
| + | </translate> | ||
Latest revision as of 00:45, 16 June 2015
ADE User Guide > ADE Server Class Reference > CAObject
Description
Returns the result of evaluating a variable as a CATable object, with zero or more dimensions, or Nothing if the variable object cannot be evaluated. A CATable is a representation of an intelligent (multi-dimensional) array, and various methods of that object are used to access the cell data. If the result is a scalar (i.e., not an array), the CATable is zero-dimensional.
The CAObject::ResultType property controls which result is computed (Mid, Sample, Mean, Statistics, Bands, PDF or CDF).
If the variable has not yet been evaluated, it is evaluated when this method is called. If this requires a lengthy calculation, the call will take a long time to complete. When CAObject::MethodEvaluationTimeLimit is set, then the result aborts if the time limit expires and ErrorCode is 77.
If an error occurs during evaluation, the ErrorCode will be set to something other than 0 or 2. If a warning occurs during evaluation, a result will be returned and the ErrorCode will be 2. The OutputBuffer contains the error message or warning.
Data type
Example Usage
CATable tab = obj.ResultTable;
ErrorCodes
This list is incomplete -- TBD
- 0 - success
- 2 - warning
- 12 - insufficient memory
- 37,38 - Could not retrieve result
- 77 - MethodEvaluationTimeLimit exceeded
- 78 - Computation aborted
Enable comment auto-refresher