$search

rqt_smach::dotcode::RosGraphDotcodeGenerator Class Reference

List of all members.

Public Member Functions

def __init__
def generate_dotcode
def generate_dotgraph
def generate_namespaces
def quiet_filter_topic_edge

Private Member Functions

def _accumulate_action_topics
def _add_edge
def _add_node
def _add_topic_node
def _filter_leaf_topics
def _filter_orphaned_edges
def _filter_orphaned_topics
def _get_node_edge_map
def _quiet_filter
def _split_filter_string

Detailed Description

Definition at line 69 of file dotcode.py.


Member Function Documentation

def rqt_smach::dotcode::RosGraphDotcodeGenerator::__init__ (   self  ) 

Definition at line 71 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_accumulate_action_topics (   self,
  nodes_in,
  edges_in,
  node_connections 
) [private]
takes topic nodes, edges and node connections.
Returns topic nodes where action topics have been removed,
edges where the edges to action topics have been removed, and
a map with the connection to each virtual action topic node

Definition at line 233 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_add_edge (   self,
  edge,
  dotcode_factory,
  dotgraph,
  is_topic = False 
) [private]

Definition at line 74 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_add_node (   self,
  node,
  rosgraphinst,
  dotcode_factory,
  dotgraph,
  quiet 
) [private]

Definition at line 80 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_add_topic_node (   self,
  node,
  dotcode_factory,
  dotgraph,
  quiet 
) [private]

Definition at line 103 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_filter_leaf_topics (   self,
  nodes_in,
  edges_in,
  node_connections,
  hide_single_connection_topics,
  hide_dead_end_topics 
) [private]
removes certain ending topic nodes and their edges from list of nodes and edges

@param hide_single_connection_topics: if true removes topics that are only published/subscribed by one node
@param hide_dead_end_topics: if true removes topics having only publishers

Definition at line 197 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_filter_orphaned_edges (   self,
  edges,
  nodes 
) [private]

Definition at line 151 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_filter_orphaned_topics (   self,
  nt_nodes,
  edges 
) [private]
remove topic graphnodes without connected ROS nodes

Definition at line 156 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_get_node_edge_map (   self,
  edges 
) [private]
returns a dict mapping node name to edge objects partitioned in incoming and outgoing edges

Definition at line 185 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_quiet_filter (   self,
  name 
) [private]

Definition at line 111 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::_split_filter_string (   self,
  ns_filter 
) [private]
splits a string after each comma, and treats tokens with leading dash as exclusions.
Adds .* as inclusion if no other inclusion option was given

Definition at line 171 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::generate_dotcode (   self,
  rosgraphinst,
  ns_filter,
  topic_filter,
  graph_mode,
  dotcode_factory,
  hide_single_connection_topics = False,
  hide_dead_end_topics = False,
  cluster_namespaces_level = 0,
  accumulate_actions = True,
  orientation = 'LR',
  rank = 'same',
  ranksep = 0.2,
  rankdir = 'TB',
  simplify = True,
  quiet = False 
)
@param rosgraphinst: RosGraph instance
@param ns_filter: nodename filter
@type  ns_filter: string
@param topic_filter: topicname filter
@type  ns_filter: string
@param graph_mode str: NODE_NODE_GRAPH | NODE_TOPIC_GRAPH | NODE_TOPIC_ALL_GRAPH
@type  graph_mode: str
@param orientation: rankdir value (see ORIENTATIONS dict)
@type  dotcode_factory: object
@param dotcode_factory: abstract factory manipulating dot language objects
@param hide_single_connection_topics: if true remove topics with just one connection
@param hide_dead_end_topics: if true remove topics with publishers only
@param cluster_namespaces_level: if > 0 places box around members of same namespace (TODO: multiple namespace layers)
@param accumulate_actions: if true each 5 action topic graph nodes are shown as single graph node
@return: dotcode generated from graph singleton
@rtype: str

Definition at line 385 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::generate_dotgraph (   self,
  rosgraphinst,
  ns_filter,
  topic_filter,
  graph_mode,
  dotcode_factory,
  hide_single_connection_topics = False,
  hide_dead_end_topics = False,
  cluster_namespaces_level = 0,
  accumulate_actions = True,
  orientation = 'LR',
  rank = 'same',
  ranksep = 0.2,
  rankdir = 'TB',
  simplify = True,
  quiet = False 
)
See generate_dotcode

Definition at line 272 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::generate_namespaces (   self,
  graph,
  graph_mode,
  quiet = False 
)
Determine the namespaces of the nodes being displayed

Definition at line 124 of file dotcode.py.

def rqt_smach::dotcode::RosGraphDotcodeGenerator::quiet_filter_topic_edge (   self,
  edge 
)

Definition at line 118 of file dotcode.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends


rqt_smach
Author(s): Jonathan Bohren
autogenerated on Tue Mar 5 11:57:43 2013