ar_set_timerrate

void ar_set_timerrate (short board, short rate);

Purpose

This function assigns the API internal timer reference resolution for compatibility with applications based on the legacy CEI-x20 product family device timer and time-tag operation. When you invoke this routine, the CEI-x30 API sets the current timer usage and time-tag reporting mode to the "CEI-x20 compatibility mode".  In this mode, all scheduled message rate and start offset values and receive message time-stamp values are referenced in terms of the resolution value assigned in the "rate" parameter instead of the standard one millisecond (for scheduled message rate/offset) or one microsecond (for receive message time-stamps).

The actual CEI-x30 hardware device time-tag reference timer resolution is not programmable; rather, it is a fixed one microsecond resolution. 

The CEI-x30 message scheduler minimum rate resolution is fixed at a one millisecond resolution.  As a result, any timer rate assignment having a resolution that is not divisible by, or is less than, one millisecond, coupled with an attempt to define a message scheduler entry rate or start offset value that is not divisible by one millisecond results in that value being assigned to the nearest 1 millisecond value below the assigned value.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

rate

short

(input) The resolution of the CEI-x20-emulated timer operation, specified as a tick-timer value having a resolution of 250 nanoseconds.

References

Timer Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description