tennsS v1.53 Reference Manual

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

Wrapper

A wrapper for the object referenced by <source>. The wrapper calls the default operator for the source object. If <parameters> are defined, then passing them as arguments. The source object is referenced and must be of type Particle. The parameters are defined using a constructed parameter set object of a type derived from Parset, by default of type Refset. 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. 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.

Naming
    source         references the source object
    parameters     references the parameter set object


Reverse References for Global Context
    owner          parameters


Control
    source         reset
    parameters     reset, dump, restore


Configuration
    source=<ref>   the source object (none)
    iteration=<v>  sets iteration index (0)
    period=<t>     sets operating period (1 cycles)
    force-parameters=<bool>
                   forces the use of the parameters (0 cycles)


Source Points
    value          the current value


Passive Points
    output         where to write the output value


Commands
    parameters type=<id> <configuration arguments passed to the
      object>
        create a parameter set object
            type=<id> the type of the object 

Derived Classes

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