Changes between Version 4 and Version 5 of Old/NodeHandler/Commands/defTopology


Ignore:
Timestamp:
Aug 28, 2007, 7:32:28 AM (17 years ago)
Author:
thierry
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Old/NodeHandler/Commands/defTopology

    v4 v5  
    66= defTopology: Define a Topology =
    77
    8 This command defines a topology consisting of a set of nodes and noise injection settings to configure a specific topology. An experiment can normally only contain a single topology with noise settings, but may create additional topology declarations which are a sub set of the 'base' topology.
     8This command defines a topology consisting of a set of nodes and optional noise injection settings to configure a specific topology.
    99
    10 == Syntax: defTopology(name, nodeArray = nil, &block = nil) ==
     10An experiment can normally only contain a single topology with noise settings, but may create additional topology declarations which are a sub set of existing topologies.
     11
     12== Syntax: ==
     13=== defTopology( name , nodeArray = nil , &block = nil ) ===
    1114
    1215  * '''name:''' Name of the defined topology.
    13   * '''nodeArray:''' Selects the nodes used in this topology.
    14   * '''block:''' Additional modifications on the create topology.
     16  * '''nodeArray:''' Selects the nodes used in this topology (optional).
     17  * '''block:''' Additional modifications on the create topology (optional).
    1518
    16 The 'name' is a uri string identifying the topology. For instance, it can be used in 'defNodes' commands. The following naming convention is encouraged: ''projectName'':'''topo''':''topologyName''
     19The 'name' argument is a uri string identifying the topology. For instance, it can be used in 'defNodes' commands. The following naming convention is encouraged: ''projectName'':'''topo''':''topologyName''
    1720
    18 The 'nodeArray' defines which nodes are in the topology. The following array patterns are supported:
     21The optional 'nodeArray' argument defines which nodes are in the topology. The following array patterns are supported:
    1922
    2023  * [x,y]: Describes a single node at location x@y
     
    2730
    2831  * '''addNode(x,y)'''  Add node at location x@y to the topology
     32
    2933  * '''removeNode(x,y)'''  Remove node at location x@y from the topology
    3034
    31 '''Instructions on how to incorporate noise are missing'''
     35  * '''size()'''  -- to be completed soon...
     36
     37  * '''getNode(index)'''  -- to be completed soon...
     38
     39  * '''getFirstNode()'''  ...
     40
     41  * '''getLastNode()''' ...
     42   
     43  * '''getRandomNode()''' ...
     44
     45  * '''getUniqueRandomNode()''' ...
     46
     47  * '''eachNode(&block)'''
     48
     49  * '''setStrict()'''
     50 
     51  * '''unsetStrict()'''
     52
     53  * '''hasNode(x, y)'''
     54
     55
     56
     57== Noise Injection: ==
     58
     59--- Instructions on how to incorporate noise are missing ---
    3260
    3361== Usage ==
     
    5886
    5987== See Also ==
     88
     89A tutotial with an example on how to use user-defined topologies within an experiment script can be found here:
     90
     91  * [wiki:Tutorial/HowToTopology How use Topologies in an experiment script]