NAME

cxLoopControlArc - Determine whether a connection carries loop data

C SPECIFICATION

#include <cx/Info.h>

cxBoolean cxLoopControlArc( int connectID )

FORTRAN SPECIFICATION

integer function cxLoopControlArc( connectID )
integer connectID

PARAMETERS

connectID
Identifier of the output connection.

FUNCTION RETURN VALUE

Returns cx_true if the connection carries a loop variable.

DESCRIPTION

cxLoopControlArc indicates whether a connection is a loop control arc. Loop control arcs are those connections which carry loop variables -- data which flows out of the loop controller, into the loop, out of the loop and back into the loop controller. More specifically, control arcs are input and output connections of loop controllers which are connected to modules inside the loop.

Note that the state of a connection is not valid when the connection is first made, and it can change because of connections or disconnections elsewhere in the map. The only time that this call is guaranteed to be accurate is when the user function is called because of the arrival of data.

SEE ALSO

cxLoopBreak(3E), cxLoopCtlr(3E), cxLoopIteration(3E)
Last modified: Mon Nov 18 13:50:48 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996