InputOverRangeAction (Data Acquisition Toolbox)

InputOverRangeAction specifies the M-file function to be executed when data sampled by an analog input channel group member exceeds its valid range. The valid range for a channel is given by the InputRange property.

Over-range checking is enabled for all channel group members only when a value is specified for InputOverRangeAction and the analog input object is running (Running is On). If a value is not specified for InputOverRangeAction, then over-range detection will not occur.

When an over-range condition is detected, a typical action to take is to determine which channel(s) went over-range. You can determine which channels experienced an over-range condition by looking at the event passed to the action function.

Characteristics


Device Objects	AI
Class	Common
Access	Read/write
Data Type	String
Modify while Running	Yes

Values

The default value is an empty string.

Example

When a channel group member experiences an over-range condition, you may want to display a message. In the example code below, overrangedisp is an M-file script that displays a simple message to the MATLAB environment.

InputOverRangeAction = 'overrangedisp'

The overrangedisp function is shown below.

function overrangedisp(obj, events)
% Display over-range message
chans = events.Data.ChannelIndex;
disp(['For the object ',obj.Name])
disp(['These channel(s) went over-range: ',num2str(chans)])