GetPar()

Get the parameter value from the data base.

Usage

par = GetPar( path, par, parType = None, default = None )

Parameters

path (string)
Data base path of the node containing the parameter.
par (string)
Parameter name.
parType (string)
Parameter type.
default (depends on parType((integer), (string),..)
Default value. This value is returned if the indicated path and par does not exist.

Return Value

par depends on parType((integer), (string),..)

The parameter value.

Errors

  • The type of the parameter in the data base must be in accordance with the parType.
  • The parameter must exist in the data base or the default must not be None.

Description

This routine returns a parameter from the data base. The parameter address is given by its node path and the par name. The parameter type is given by parType. If the parameter does not exist, the default value is returned. For example,
arrayPar = GetPar( name, path, ARRAY, default )