InputOverRangeFcn

Specify callback function to execute when acquired data exceeds valid hardware range

Description

An input overrange event is generated immediately after an overrange condition is detected for any channel group member. This event executes the callback function specified for InputOverRangeFcn.

An overrange condition occurs when an input signal exceeds the range specified by the SensorRange property. Overrange detection is enabled only if the analog input object is running and a callback function is specified for InputOverRangeFcn.

Input overrange event information is stored in the Type and Data fields of the EventLog property. The Type field value is OverRange. The Data field values are given below.

    Note:   The input overrange event is not generated if a signal begins outside the range and then goes into the range.

Data Field Value

Description

AbsTime

The absolute time (as a clock vector) the event occurred.

Channel

The index of the channel that experienced an overrange signal.

OverRange

The OverRange value, Off indicates that the channel went from overrange to in range, and On indicates that it went from in range to overrange.

RelSample

The acquired sample immediately before the moment when the overrange transition occurs.

    Note:   The input signal values will not exceed the values set by the InputRange property. If you set InputRange and SensorRange to the same value, the OverRange event is never received. To receive OverRange events set the value of SensorRange within, and not equal to, the InputRange value.

Characteristics

Usage

AI, common to all channels

Access

Read/write

Data type

String

Read-only when running

No

Values

The default value is an empty string.

See Also

Properties

EventLog, SensorRange

Was this topic helpful?