Incremental counters

Detailed Description

This package permits the addition of an incremental counter to each update that passes through the system.

The following example creates a copy of the incoming packet, adds a counter to it, and then publishes the new update:

require("counters")

function update(incoming)
   outgoing = incoming:clone()
   counter.add(outgoing)
   outgoing:send()
end

Functions
	counter.add (var normal)
	Add an incremental counter to the normalised update. More...
	counter.cleanup (var name)
	Cleanup the incremental counter. More...

Function Documentation

counter.add

(

var

normal

)

Add an incremental counter to the normalised update.

Parameters

normal

- Normalised update

Returns

Nothing

This function uses the following database keys on the symbol:

TickCount

This function uses the following data dictionary keys:

TickCountField

counter.cleanup

(

var

name

)

Cleanup the incremental counter.

Parameters

name	- Symbol name to reset counter for

Returns

Nothing

This function uses the following database keys on the symbol:

TickCount

Note

The value is reset to 0, since counter.add() increments the value before adding it to the normalised update