tennsS v1.53 Reference Manual

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

Particle

The root class object. All objects in the system are derived from the Particle class. This class handles basic housekeeping functionality within the system, such as the reset, dump, restore and describe functions.

Naming
    object/<tag>   references object <tag>
    <type>         all referenced objects of <type>


Reverse References for Global Context
    owner          object/<tag>


Control
    object/<tag>   reset, dump, restore


Commands
    describe
        describe the particle

    make type=<id> tag=<tag> [replace=<bool>] [reuse=<bool>]
      <configuration for the created object>
        create an object of specified type which can be identified
          relative to the calling object using <tag>
            type=<id> the type of the created object 
            tag=<tag> the tag used to identify the object relative
              to the calling object 
            replace=<bool> whether to replace any object that
              may already be referenced by <tag> 
            reuse=<bool> whether to use any existing object that
              may already be referenced by <tag> instead of creating
              a new object 

    probe [active=<n>] [tag=<n>] <passive sources to be attached
      to the probe defined relative to the calling object>
        create and manage a probe that is registered with the
          calling object and identified relative to the calling
          object using object/<tag>
            active=<n> the trigger point relative to the calling
              object used to activate the probe 
            tag=<n> the tag used to identify the probe relative
              to the calling object 

    particles <list of references>
        list all the particles that are referenced by each of
          the arguments

    print <list of source points>
        print the current values for each of the specified source
          points

    namespace [recurse=<bool>]
        list the local name space
            recurse=<bool> whether to list recursively 

    reset
        reset the state of the particle

    check
        check the integrity of the particle

    operator [quiet=<bool>] <list of arguments>
        pass the list of arguments to the operator function for
          the particle
            quiet=<bool> whether to execute quietly 

    dump
        dump the state of the particle to the output stream

    restore
        restore the particle state from the input stream

    passive reference=<passive> source=<source> [detach=<bool>]
        sets the specified <reference> to point to the specified
          <source> point
            reference=<passive> the passive reference point defined
              relative to the calling object which can be used
              to store the reference(s) to the source point(s)
              which are given by <source> 
            source=<source> the source point(s) defined relative
              to the calling object which will be referenced by
              <reference> 
            detach=<bool> to remove the reference instead of
              setting up the reference 

    active reference=<active> source=<ref> [detach=<bool>]
        sets the specified <reference> to point to the specified
          <source> object
            reference=<active> the active reference point or
              trigger point defined relative to the calling object
              which can be used to store the reference(s) to the
              object(s) of type Particle which are given by <source>
            source=<ref> the object(s) of type Particle defined
              relative to the calling object which will be referenced
              by <reference> 
            detach=<bool> to remove the reference instead of
              setting up the reference 

Derived Classes

• Atom
• Channel
• Netconn
• Netnode
• Owned

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