tennsS v1.53 Reference Manual

Go to the previous, next section, table of contents.

Queue

A queue-based wrapper for the object referenced by <source>. The wrapper calls the default operator for the source object. The source object is referenced and must be of type Particle. The parameters passed as arguments to <source> are stored in a queue of fixed <length>. The queue is filled by calling the default operator for the object referenced by <queue> where new values are pushed on to the end of the queue and popped off the start of the queue. The queue object is referenced and must be of type Particle. A new value is added to the queue prior to calculating the value of the wrapper. The value of the wrapper is stored and is calculated only once every <period> times the wrapper is called. The other times the stored value is returned without a re-calculation and without adding a new value to the queue. The timing of the next calculation can be controlled using <iteration>. The value of the wrapper may be used to set the data reference given by <output> if set. If <fill> is set, then upon reset, the queue is initialised with zeros to the correct length, otherwise it is initialised as empty.

Naming
    source         references the source object
    queue          references the queue object


Control
    source         reset


Configuration
    fill=<bool>    initialise with zeros (0)
    source=<ref>   the source object (none)
    queue=<ref>    the queue object (none)
    length=<uint>  sets queue length (1)
    iteration=<uint>
                   sets iteration index (0)
    period=<uint>  sets operating period (1 cycles)


Source Points
    value          the current value


Passive Points
    output         where to write the output value

Derived Classes

Go to the previous, next section, table of contents. Document generated Mon Jun 16 02:19:05 GMT 2003