NAME

cxFireDataChanged, cxFireDataChangedV - check if the data on the "Fire" port is new

C SPECIFICATION

#include <cx/PortAccess.h>

int cxFireDataChanged ()

int cxFireDataChangedV (int *changeVec[] )

FORTRAN SPECIFICATION

integer function cxFireDataChanged ()

integer function cxFireDataChangedV(pChangedVec) pointer (pChangedVec, changedVec) integer changedVec(1)

PARAMETERS

changeVec
Set to the address of an array of integers indicating whether there is new data from each connection on the "Fire" port.

FUNCTION RETURN VALUE

cxFireDataChanged returns a non-zero value if the "Fire" port has new data.

cxFireDataChangedV returns the number of values in the changeVec array.

DESCRIPTION

cxFireDataChanged returns a non-zero value if the "Fire" port has new data. The status of input port data does not change during the firing of a module. Hence, this routine is most useful if used at the beginning of a firing cycle to determine whether the module has fired due to new data on the "Fire" port, when used in conjunction with cxInputDataChanged to check other ports.

cxFireDataChangedV sets changeVec to the address of an array which contains a non-zero (or zero) value for each connection that has new data, and returns the number of connections in the array. The changeVec array is static and must not be deallocated. The changed flags correspond to the array of connection identifiers returned by cxInputDataConnIDGetV. cxFireDataChangedV will not return the current number of connections if connections were made and then disconnected. See cxInputDataGet for a discussion of what data value and changed flag are used in this case.

The port is considered new if any of the connections have new data. The port will be old the next time the module fires if no new data has arrived. It is not necessary to call cxInputDataGet or cxInputDataGetV for the "Fire" port.

SEE ALSO

cxInputDataChanged(3E), cxInputDataChangedV(3E), cxInputDataGet(3E), cxInputDataGetV(3E), cxInputDataConnIDGetV(3E).
Last modified: Mon Nov 18 13:48:31 GMT 1996
[ Documentation Home ]
© The Numerical Algorithms Group Ltd, Oxford UK. 1996