Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Support Characteristics for MathScript Functions (MathScript RT Module)

LabVIEW 2012 MathScript RT Module Help

Edition Date: June 2012

Part Number: 373123C-01

»View Product Info
Download Help (Windows Only)

The following sections define the support characteristics documented in the reference topic for each built-in MathScript function.

Causes Reduced Performance

This category denotes functions which, when called from a MathScript Node, might change the MathScript search path list at run time or might introduce new variables at run time. A warning glyph, shown as follows, appears next to the line from which you call one of these functions.

The warning glyph indicates that LabVIEW operates with reduced error checking at edit time and slower run-time performance for the MathScript Node. You can modify your script to remove the warning glyph from the MathScript Node and improve run-time performance.

Supported in the LabVIEW Run-Time Engine

This category specifies if you can use the function in a stand-alone application or shared library. Functions possess one of the following characteristic values:

  • Yes—The function is fully supported in the LabVIEW Run-Time Engine.
  • Yes (if you request output)—If you assign the output of the function to a MathScript variable, the LabVIEW Run-Time Engine executes the function as normal. Otherwise, the Run-Time Engine just ignores the function. For example, the Run-Time Engine supports a = coherence(x, y), but not coherence(x, y). This behavior occurs because the Run-Time Engine does not support the plots generated when you do not assign the output to a variable.

    These functions can remain in your scripts.
  • No—The function always returns an error when called in the LabVIEW Run-Time Engine.

    Remove the function from your scripts before you build a stand-alone application or shared library.
  • No (returns error or is ignored)—If you assign the output of the function to a MathScript variable, the function returns an error. Otherwise, the LabVIEW Run-Time Engine just ignores the function.

    Either do not assign the output to a variable or remove these functions from your scripts before you build a stand-alone application or shared library.
  • No (always ignored)—The function does not return an error, but the LabVIEW Run-Time Engine does not execute the function.

    These functions can remain in your scripts.
  • Other—Refer to the Details section in the function topic for information about the behavior of the function and how to modify scripts that contain the function in order to include it in a stand-alone application or shared library.

Supported on RT Targets

This category specifies if you can use the function in an application you deploy to a real-time hardware target. Functions possess one of the following characteristic values:

  • Yes—The function is supported on RT targets.
  • Yes (if you request output)—If you assign the output of the function to a MathScript variable, the RT target executes the function as normal. For example, RT targets support a = coherence(x, y), but not coherence(x, y). This behavior occurs because RT targets do not support the plots generated when you do not assign the output to a variable.
  • No—The function is not supported on RT targets.

Suitable for Bounded Execution Times on RT

If the function is supported on RT targets, this category specifies whether the function typically executes in a bounded amount of time when used according to certain guidelines. Functions possess one of the following characteristic values:

  • Yes—National Instruments has tested and classified a subset of MathScript functions as suitable for bounded execution times. When determinism in your application is important, use these functions and ensure inputs to the functions are of the data types recommended in the help topic for each function so LabVIEW does not coerce the input values.
  • No (affects entire script)—The function is supported on RT targets but it is known to cause unbounded execution times throughout the entire MathScript Node, including the entire call chain of user-defined functions if a user-defined function contains the function.

    Avoid using these function in MathScript Nodes and user-defined functions.
  • Not characterized—National Instruments has not tested or classified the function as suitable or unsuitable for bounded execution times. To ensure that the application meets timing requirements, National Instruments recommends that you review your code and benchmark the jitter in your application before you deploy the application to the field.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit