Parameters
Remarks
Revisions
Example
See Also
Declaration
void __stdcall forEachAgentVar( bool (*func)(pState,int,int,pState*, // name of function int,int,double*,int), double* var, // workspace int varCount // size of workspace );
Parameters
- func
- The name of a function to apply to each agent in turn.
- var
- Allocated array of storage space for extra parameters.
- varCount
- Size of array, var[0..varCount-1].
Remarks
This function is available through the API. It provides an efficient way to process every agent in turn.func
func is the name of a function with the following declaration:bool func( pState state, // array of agent state variables int x, // X-coordinate of agent int y, // Y-coordinate of agent pState *nbr, // array of neighbours int nbrCount, // size of nbr array, nbr[0..nbrCount-1] int feaMode, // calling mode, one of feaBegin, feaContinue or feaEnd double *var, // workspace int varCount // size of workspace );The details of this function are the same as that for forEachAgent except for the addition of two extra parameters, var and varCount. var[0..varCount-1] is an array of double values (allocated by the model programmer) which are passed through the call to forEachAgentVar to the function func, providing storage space.
Revisions
API v1.5- no longer passes param to func
Example