Package svs_simulation :: Package terrain :: Module paths :: Class Path
[show private | hide private]
[frames | no frames]

Class Path

DGraph --+        
         |        
    UGraph --+    
             |    
      NavGraph --+
                 |
                Path


A path defines a routes between two or more locations in terms of a series of linked node points.
Method Summary
  __init__(self, name)
  __str__(self)
Returns representation of self as string.
  addNode(self, x, y, name)
Creates new node and adds it to graph.
  addNodeObject(self, nodeObject)
Adds existing node to graph.
  decode(self, data)
Sets self to encoded values.
  encode(self)
Returns encoded description of self.
  enterNode(self, entity)
  exitNode(self, entity)
  mapToTerrain(self, terrain)
Checks nodes in path route against terrain, linking each node to the structure in which it is located.
  reverse(self)
Creates reverse version of path.
    Inherited from NavGraph
  addEdge(self, head, tail)
Adds new edge.
  clearTransitionNode(self, node)
Clears transition link for node.
  encodeEdge(self, edge)
Encodes edge data.
  getNodesInArea(self, area)
Collects nodes in specified area.
svs_simulation.simdata.simdatalib.SimData getSimDataForEdge(self, edge)
Returns simulation data for edge.
  getValidEdges(self)
Returns a list of valid edges.
  getValidNodes(self)
Returns a list of valid nodes.
  isAccessibleArea(self, area)
Checks if area can be entered.
  isValidEdge(self, edge)
Checks if edge is hidden or not.
  isValidNode(self, node)
Checks if node is hidden or not.
  removeEdge(self, edge)
Removes an edge from the graph.
  removeEdges(self, edges)
Removes listed edges from graph.
  removeNode(self, node)
Removes node from the graph.
  setSimDataForEdge(self, edge, simdata)
Attaches simulation data to edge.
  setTransitionNode(self, node, link)
Sets transition link for node.
    Inherited from UGraph
  add_edge(self, head, tail, wt, data, create_nodes)
Adds a directed edge going from head to tail.
  all_degree(self, node)
The total degree of a node
  all_nbrs(self, node)
The total degree of a node
  graph_error(self, msg)
Reports an error message
  number_of_edges(self)
Returns the number of edges
    Inherited from DGraph
  __contains__(self, node)
Test whether a node is in the graph
  __iter__(self)
Iterates over all nodes in the graph
  __len__(self)
Returns the number of nodes
  __repr__(self)
User friendly and verbose representation
  add_node(self, node, data)
Creates a new node with a node.
  all_edges(self, node)
Returns a list containing all incoming and outging edges
  edge_data(self, edge)
Returns the data associated with an edge
  edge_head(self, edge)
Returns the head of the edge.
  edge_list(self)
Returns a list of all edge_ids in the graph
  edge_nodes(self, edge)
Returns the head and the tail of an edge.
  edge_tail(self, edge)
Returns the tail of the edge.
  get_edge(self, head, tail)
Returns the edge that connects the head to tail
  get_edge_data(self, edge)
Sets the data for an edge
  get_edge_wt(self, edge)
Gets the wt of the edge
  hide_edge(self, edge)
Hides an edge from the graph.
  hide_node(self, node)
Hides a node from the graph.
  inc_degree(self, node)
Returns the number of incoming edges
  inc_edges(self, node)
Returns a list of the incoming edges
  inc_nbrs(self, node)
Returns a list of nodes connected by incoming edges.
  node_data(self, node)
Returns the data associated with a node
  node_list(self)
Returns a list of the nodes in the graph.
  number_of_hidden_edges(self)
Returns the number of hidden edges.
  number_of_hidden_nodes(self)
Returns the number of hidden nodes.
  number_of_nodes(self)
Returns the number of nodes
  out_degree(self, node)
Returns the number of outgoing edges
  out_edges(self, node)
Returns a list of the outgoing edges.
  out_nbrs(self, node)
Returns a list of nodes connected by outgoing edges.
  restore_all_edges(self)
Restores all hidden edges.
  restore_all_nodes(self)
Restores all hidden nodes.
  restore_edge(self, edge)
Restores a hidden edge.
  restore_node(self, node)
Restores a hidden node
  set_edge_data(self, edge_id, edge_data)
Sets the data for an edge
  set_edge_wt(self, edge, wt)
Sets the wt of the edge

Method Details

__str__(self)
(Informal representation operator)

Returns representation of self as string.
Overrides:
pygraphlib.pygraph.UGraph.__str__

addNode(self, x, y, name=None)

Creates new node and adds it to graph.
Overrides:
svs_simulation.terrain.navgraphs.NavGraph.addNode

addNodeObject(self, nodeObject)

Adds existing node to graph.

decode(self, data)

Sets self to encoded values.

@type data:dict
Overrides:
svs_simulation.terrain.navgraphs.NavGraph.decode

encode(self)

Returns encoded description of self.

@rtype:dict
Overrides:
svs_simulation.terrain.navgraphs.NavGraph.encode

mapToTerrain(self, terrain)

Checks nodes in path route against terrain, linking each node to the structure in which it is located.

reverse(self)

Creates reverse version of path.

Generated by Epydoc 2.1 on Thu Oct 20 15:30:26 2005 http://epydoc.sf.net