Cascade Driver for Hilscher Fieldbus CIF Cards: Version 4.1
Prev |  | Next

# cycleModify

cycleModify -- queries, changes, or sets the cycle time of a point.

## Synopsis

    (cycleModify point_name [cycle_millisecs])

## Parameters

`point_name`

  The name of an existing point.

`cycle_millisecs`

  Optional. The new point cycle time in milliseconds. If not specified, then the current cycle time of the specified point is returned.

## Returns

`(cycleModify `point_name` `cycle_millisecs`)` or `(error).`

## Description

This command queries, changes or sets the cycle time attribute of the specified point. The cycle time provides a mechanism for automatically reading/writing a point on a periodic basis (see analog, digital, group or heartbeat commands). If the point is already being processed periodically, the cycle time takes effect after the current cycle period completes. A cycle time of zero will cancel the periodic processing of the point, while a non-zero cycle time will add it to the list of points to be processed, if it is not already on that list.

This command is not commonly used, and mainly provides a debug mode facility to experiment with performance as a function of cycle times.

## Example

        (cycleModify digital_input_group 50)

Prev | Home | Next
cycle | Up | datahub

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