Database.setScriptedResultsEntity


setScriptedResultsEntity(name, [index])

There is a special results entity (by default called "Scripted") which allows the calculation and storage of arbitary results for later plotting. Without an optional argument (or if 0 is given), this function changes the name of that entity to the name given. That name then appears in the properties dialog of results layers such as contours. By default there is only one such entity. However, by calling addScriptedResultsEntity, you can add as many as you need and use this function to subsequently change their names too. 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.

namestring
indexoptional integer default 0. If non-zero, sets up additional scripted results entities
Return valuenone 

See also flushScriptedResults initialiseScriptedResults specifyResultsUpdateScript setNodeScriptedResults setGaussScriptedResults setScriptedResults

Back to Database

Back to Overview