Cascade Historian: Version 4.1
Prev |  | Next

# 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 (arg1info) ... (argninfo))

whose members are as follows:

`function`

  The name of the interpolate function requested.

`description`

  A string giving a general description of the function.

`argiinfo`

  A list with this syntax: `(`arginame` `argitype` `argioption` `argidescription`), whose elements are as follows:`

  `arginame`

    The argument name, as a string.

  `argitype`

    The argument type, as a string.

  `argioption`

    `1` if the argument is optional. Otherwise `0`.

  `argidescription`

    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"))

Prev | Home | Next
interpolate | Up | interpolatorList

Copyright 1995-2002 by Cogent Real-Time Systems, Inc.