There is a special results entity (by default called "Scripted") which allows the calculation and storage of arbitary results for later plotting. This function allows you to add additional names for the same purpose. The given name then appears in the properties dialog of results layers such as contours. The returned index uniquely identifies the new entity to the system, such that you can modify the name at any future stage by calling setScriptedResultsEntity. You can also use this index (if you wish) in place of the entity name in many other functions. It is not an error to repeatedly call this function with the same entity name - second and subsequent calls will simply retrieve the index of the entity which is already present. Note that the results will not be removed from the system (and so will potentially use a large amount of memory) until explicitly removed with a call to flushScriptedResults.
| name | string | Name to add |
| Return value | integer | Index which may be used to subsequently change the name |
See also flushScriptedResults initialiseScriptedResults specifyResultsUpdateScript setNodeScriptedResults setGaussScriptedResults setScriptedResults
Back to Database
Back to Overview