Node.setScriptedResults


setScriptedResults(val, entity, [component])

Specify a named result value at node Only really useful when called for all visible nodes Then allows (for example) drawing of smoothed contours of any arbitary values. The entity may be given either as a name, or as an index previously registered using addScriptedResultsEntity. If the entity is given as a string and does not already exist, it will be created. If the component does not already exist within the given entity, a new component is created within the given entity. 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.

valdoubleUser results value
entitystring or long Name or index of results entity
componentstring Name of results component
Return valuenone 

Example


' set averaged results
 entity = db.addScriptedResultsEntity("MyEntityName")
 call node.setScriptedResults(myResultValue, entity, "MyComponentName")

See also flushScriptedResults initialiseScriptedResults setScriptedResultsEntity specifyResultsUpdateScript setNodeScriptedResults setGaussScriptedResults

Back to Node

Back to Overview