Cascade Historian™ : Version 6.4
	Commands

`interpolatorDescribe`

interpolatorDescribe — describes each of the interpolate functions.

Syntax

(interpolatorDescribe function)

Parameters

function: The name of an interpolate function, as shown in the interpolate documentation, or as listed by the interpolatorList command.

Returns

A list with the following syntax:

(interpolatorDescribe function description (arg₁info) ... (arg_ninfo))

whose members are as follows:

function

The name of the interpolate function requested.

description

A string giving a general description of the function.

arg_iinfo

A list with this syntax: (arg_iname arg_itype arg_ioption arg_idescription), whose elements are as follows:

arg_iname: The argument name, as a string.
arg_itype: The argument type, as a string.
arg_ioption: 1 if the argument is optional. Otherwise 0.
arg_idescription: A description of the argument, as a string.

Example

Hist> (interpolatorDescribe FixedRelativeInterpolator)
(interpolatorDescribe FixedRelativeInterpolator "Generates
interpolated data pairs from the specified histories (Y vs X)
at times corresponding to actual values of X." ("X" "history"
0 "Name of history to be used as the X axis"))


interpolate		interpolatorList