Public Member Functions | Public Attributes | Static Public Attributes | Private Member Functions
rqt_graph.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
def statistics_callback

Public Attributes

 stats_sub

Static Public Attributes

tuple edges = dict([])
tuple nodes = dict([])

Private Member Functions

def _accumulate_action_topics
def _add_edge
def _add_node
def _add_topic_node
def _calc_edge_color
def _calc_edge_penwidth
def _calc_statistic_info
def _filter_leaf_topics
def _filter_orphaned_edges
def _filter_orphaned_topics
def _get_max_age
def _get_max_age_on_topic
def _get_max_traffic
def _get_node_edge_map
def _quiet_filter
def _split_filter_string

Detailed Description

Definition at line 72 of file dotcode.py.


Constructor & Destructor Documentation

Definition at line 80 of file dotcode.py.


Member Function Documentation

def rqt_graph.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 366 of file dotcode.py.

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

Definition at line 192 of file dotcode.py.

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

Definition at line 213 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._add_topic_node (   self,
  node,
  dotcode_factory,
  dotgraph,
  quiet 
) [private]

Definition at line 236 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_edge_color (   self,
  sub,
  topic,
  pub = None 
) [private]

Definition at line 121 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_edge_penwidth (   self,
  sub,
  topic,
  pub = None 
) [private]

Definition at line 152 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_statistic_info (   self,
  sub,
  topic,
  pub = None 
) [private]

Definition at line 164 of file dotcode.py.

def rqt_graph.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 330 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._filter_orphaned_edges (   self,
  edges,
  nodes 
) [private]

Definition at line 284 of file dotcode.py.

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

Definition at line 289 of file dotcode.py.

Definition at line 107 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._get_max_age_on_topic (   self,
  sub,
  topic 
) [private]

Definition at line 115 of file dotcode.py.

Definition at line 99 of file dotcode.py.

returns a dict mapping node name to edge objects partitioned in incoming and outgoing edges

Definition at line 318 of file dotcode.py.

def rqt_graph.dotcode.RosGraphDotcodeGenerator._quiet_filter (   self,
  name 
) [private]

Definition at line 244 of file dotcode.py.

def rqt_graph.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 304 of file dotcode.py.

def rqt_graph.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 519 of file dotcode.py.

def rqt_graph.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 405 of file dotcode.py.

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

Definition at line 257 of file dotcode.py.

Definition at line 251 of file dotcode.py.

Definition at line 88 of file dotcode.py.


Member Data Documentation

Definition at line 75 of file dotcode.py.

Definition at line 78 of file dotcode.py.

Definition at line 80 of file dotcode.py.


The documentation for this class was generated from the following file:


rqt_graph
Author(s): Dirk Thomas
autogenerated on Wed Sep 16 2015 06:57:53