Changes between Version 5 and Version 6 of Documentation/NodeHandler/Commands/defTopology

Timestamp:

08/28/07 20:46:16 (3 years ago)

Author:

thierry

Comment:

--

Documentation/NodeHandler/Commands/defTopology

@@ -29 +29 @@
 The optional 'block' allows the experimenter to further configure the topology. The following commands are defined inside the block:
 
-  * '''addNode(x,y)'''  Add node at location x@y to the topology
+  * '''addNode(x,y)'''  Add node at location x@y to the topology.
 
-  * '''removeNode(x,y)'''  Remove node at location x@y from the topology
+  * '''removeNode(x,y)'''  Remove node at location x@y from the topology.
 
-  * '''size()'''  -- to be completed soon...
+  * '''size()'''  Return the number of nodes in this topology.
 
-  * '''getNode(index)'''  -- to be completed soon...
+  * '''getNode(index)'''  Return the node at the position ''index'' in this topology. Return ''nil'' if ''index'' is greater than the number of nodes in the topology.
 
-  * '''getFirstNode()'''  ...
+  * '''getFirstNode()'''  Return the node at the 1st position in this topology.
 
-  * '''getLastNode()''' ...
+  * '''getLastNode()''' Return the node at the last position in this topoly.
    
-  * '''getRandomNode()''' ...
+  * '''getRandomNode()''' Return a random node from this topology. Subsequent calls to this method may return the same node.
 
-  * '''getUniqueRandomNode()''' ...
+  * '''getUniqueRandomNode()''' Return a unique random node from this topology. Subsequent calls to this method will never return the same node, i.e. once a node is randomly selected it is "removed from the bag of nodes" of this topology. When all the available nodes in this topology have been drawn, this method will return ''nil'' and output a warning message to the console.
 
-  * '''eachNode(&block)'''
+  * '''eachNode(&block)''' Execute the commands in ''block'' on each node within this topology.
 
-  * '''setStrict()''' 
+  * '''setStrict()''' Set the ''strict'' flag for this topology. When the ''strict'' flag is set, adding or removing a node from this topology is not permitted, and will result in an error message on the console and the termination of the experiment. Typically a user sets this flag when s/he wants an experiment to proceed only if all the required nodes are present in this topology. By default, the ''strict'' flag is NOT set for a topology.
   
-  * '''unsetStrict()'''
+  * '''unsetStrict()''' Unset the "strict" flag. By default, the ''strict'' flag is NOT set for a topology.
 
-  * '''hasNode(x, y)'''
+  * '''hasNode(x, y)''' Return ''true'' if the node at location x@y is part of this topology, return ''false'' otherwise.
 
 
@@ -62 +62 @@
 
 {{{
-# topology contains 1 node
-defTopology('test:topo:origin', [1, 1]) 
+# Define a topology that contains 4 specific nodes
+#
+defTopology('test:topo:origin', [[1, 1],[2,5],[10,4],[15,1]]) 
 
-# nodes arranged in a circle
+# Define a topology where nodes on the testbed are arranged 
+# in a circle
+#
 defTopology('test:topo:circle') { |t|
   # use simple 4-way algorithm
@@ -83 +86 @@
   }
 }
+
+
+# Define a topology that will have 8 nodes randomly selected from 
+# a previously defined topology (''topo_grid_active'' which includes all the 
+# currently active node on the grid testbed)
+#
+defTopology('myTopo8Nodes') { |t|
+  
+  # Load the 'topo_grid_active' 
+  baseTopo = Topology['topo_grid_active']
+  # Print the size of the base topology
+  puts "Size of the Base Topology: #{baseTopo.size}"
+  
+  # Repeat the following 8 times
+  for count in 1..8
+    # Draw a random node from the base topology
+    aNode = baseTopo.getUniqueRandomNode
+    # Add this random node to this 'myTopo8Nodes' topology
+    t.addNode(aNode.x, aNode.y)
+  end
+  
+  # Print the nodes that belongs to this topology
+  puts "Size of the 'myTopo8Nodes' Topology: #{t.size}"
+  t.eachNode { |n|
+    puts " - Node: #{n}"
+  }
+}
 }}}