GetTarea()
Get a Tarea (Text area) parameter from the data base.
Usage
tAreaPar = GetTarea( path, par, default=None )
Parameters
- path (string)
- Data base path of the node containing the parameter.
- par (string)
- Parameter name.
- default (string)
- Default value. This value is returned if the indicated path and par does not exist.
Return Value
- tareaPar (string)
- The parameter value.
Errors
- The parameter in the data base must be of type string.
- The parameter must exist in the data base or the default must not be None.
Description
This routine returns a text area parameter from the data base. The parameter address is given by
its node path and the par name. If the
parameter does not exist, the default value is returned. For
example:
nodeNic = ROOT + RS + 'NODAL_INITIAL_CONDITION'
funcX = GetTarea( nodeNic + RS + 'x_velocity', "script" )