*RegisterResultMathPlugin()

Defines a plug-in based operator, which is available through the Expression Builder under the plug-in library.

Syntax

*RegisterResultMathPlugin (name, help_string, type, path, format, entity, begin_proc, record_proc, end_proc)

Application

HyperView

Inputs

name
The name of the plug-in operator.
help_string
The help string (visible when the operator help is shown in the Expression Builder).
type
The type of interpreter to be used with the script as defined by path.
Options include Tcl, Templex, or HyperMath.
path
The filename and path to the script file containing the Tcl, Templex, or HyperMath procedures.
format
The format of the result stored by the plug-in. Options include scalar, tensor, or vector.
entity
The entity type to which the answer will be bound. Options include nodes or elements.
begin_proc
An optional procedure to be executed before a layer/pool is processed.
record_proc
The name of a Tcl procedure or Templex function which will be called for every entity. This is a mandatory procedure executed for each input record.
end_proc
An optional procedure called when a layer/pool has been processed.

Context

*BeginDefaults()

*BeginGraphicDefaults()

Example

*BeginGraphicDefaults()
    *RegisterResultMathTemplate(“Advanced”, “C:/software/hv11-rmath/io/                                         result_readers/rmxml/advanced.xml”)
    *RegisterResultMathPlugin(MaxComp, "Find max component of vector", TCL,                                   {getenv("ALTAIR_HOME") + "/hw/tcl/post/                                          ResultMathPlugin/Example.tcl"}, SCALAR, NODES,                                  "OnBegin", "OnRecord", "OnEnd")    
*EndGraphicDefaults()

Comments

This statement can only be used if the Advanced result math template is used. The name of the operation is defined by the first argument, while the remainder of the arguments define the input and output of the plug-in operator.