SaveResults, ReadResults

[PetrS]

size=150bSaveResults and ReadResults methods/b/size
Version 0.1.33 and higher

SaveResults and ReadResults are functions used to store semi-results in IO structure.
These functions allows sharing results between various calculations, between master and slave or between various calculation runs (over combinations and sections).

ubSyntax:/b/u
bStructure SaveResults(ResultType ResultType, string Key)/b
list
*ResultType - enum (Member, Section, Combi) which defines where the results are going to be saved/*:m
*Key - Name of result set/*:m
*Return value - results set saved to the specified location/*:m/list:u
Saves structured variable which contains all the calculation result variables (ESA_ID starts with "Result.") to the given results node.


bStructure ReadResults(ResultType ResultType)/b
list
*ResultType - enum (Member, Section, Combi) which defines where the results are going to be saved/*:m
*Return value - complete results node of specified type/*:m/list:u
Reads complete result node of specified type. You can use this function to access results node directly.

bStructure ReadResults(ResultType ResultType, string Key)/b
list
*ResultType - enum (Member, Section, Combi) which defines where the results are going to be saved/*:m
*Key - Name of result set/*:m
*Return value - results set of given name from specified location/*:m/list:u
Reads specific results set from result node of specified type.

ubRemark 1:/b/u
Calculation results saved by the SaveResults command are persistent over CalcExe run.
No calculation results are deleted, it remains in the datacache until CalcExe is terminated.
=> Calculation results can be reused by different CLCs called within one instance of CalcExe.

ubRemark 2:/b/u
Calculation results should be used to avoid multiple calls of one calculation.
For example calculation of average stirrup characteristics (ss, Asw, ...) should be called only once (for first combination of internal forces calculated on given section). Calculation for second and next combination of internal forces on this section should reuse these results (stirrup characteristic)!
See attached examples for further details.

ubRemark 3:/b/u
ResultType defines the location where the result set is saved.

For calculations connected to Scia Engineer:
list
*ResultType.Member - Results are saved to <Member>.<"Results">.<Key>/*:m
*ResultType.Section- Results are saved to <Section>.<"Results">.<Key>/*:m
*ResultType.Combi- Results are saved to <Combi>.<"Results">.<Key>/*:m/list:u

For standalone run:
list
*ResultType.Member - Results are saved to IO.Results.Member.<Key>/*:m
*ResultType.Section- Results are saved to IO.Results.Section.<Key>/*:m
*ResultType.Combi- Results are saved to IO.Results.Combi.<Key>/*:m/list:u

[PetrS]

size=150SaveResults command extension/size

SaveResults command was extended by optional parameter "Value" which defines value saved to results.

ubSyntax:/b/u
bStructure SaveResults(ResultType ResultType, string Key)/b
list
*ResultType - enum (Member, Section, Combi) which defines where the results are going to be saved/*:m
*Key - Name of result set/*:m/list:u
Return value - Result set (structured variable) saved to the specified location
iThis command saves structured variable which contains all the calculation result variables (ESA_ID starts with "Result.") to the given results node./i


bStructure SaveResults(ResultType ResultType, string Key, object Value)/b
list
*ResultType - enum (Member, Section, Combi) which defines where the results are going to be saved/*:m
*Key - Name of result set/*:m
*Value - Value saved to specified location/*:m/list:u
Return value - Value saved to the specified location
iThis command saves given value to the given results node./i