Public Member Functions | Private Member Functions
rocon_gateway_graph.dotcode.RosGraphDotcodeGenerator Class Reference

List of all members.

Public Member Functions

def __init__
def generate_dotcode
def generate_dotgraph
def generate_namespaces

Private Member Functions

def _add_edge
def _add_node
def _add_topic_node
def _filter_leaves
def _filter_orphaned_edges
def _filter_orphaned_topics
def _get_node_edge_map
def _split_filter_string

Detailed Description

Definition at line 45 of file dotcode.py.


Constructor & Destructor Documentation

Definition at line 47 of file dotcode.py.


Member Function Documentation

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

Definition at line 50 of file dotcode.py.

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

Definition at line 56 of file dotcode.py.

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

Definition at line 81 of file dotcode.py.

def rocon_gateway_graph.dotcode.RosGraphDotcodeGenerator._filter_leaves (   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 157 of file dotcode.py.

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

Definition at line 111 of file dotcode.py.

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

Definition at line 116 of file dotcode.py.

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

Definition at line 145 of file dotcode.py.

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 131 of file dotcode.py.

def rocon_gateway_graph.dotcode.RosGraphDotcodeGenerator.generate_dotcode (   self,
  rosgraphinst,
  ns_filter,
  topic_filter,
  graph_mode,
  dotcode_factory,
  show_all_advertisements = False,
  hide_dead_end_topics = False,
  cluster_namespaces_level = 0,
  orientation = 'LR',
  rank = 'same',
  ranksep = 0.2,
  rankdir = 'TB',
  simplify = True 
)
@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: GATEWAY_GATEWAY_GRAPH | GATEWAY_PULLED_GRAPH | GATEWAY_FLIPPED_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)
@return: dotcode generated from graph singleton
@rtype: str

Definition at line 294 of file dotcode.py.

def rocon_gateway_graph.dotcode.RosGraphDotcodeGenerator.generate_dotgraph (   self,
  rosgraphinst,
  ns_filter,
  topic_filter,
  graph_mode,
  dotcode_factory,
  show_all_advertisements = False,
  hide_dead_end_topics = False,
  cluster_namespaces_level = 0,
  orientation = 'LR',
  rank = 'same',
  ranksep = 0.2,
  rankdir = 'TB',
  simplify = True 
)
See generate_dotcode

Definition at line 193 of file dotcode.py.

Determine the namespaces of the nodes being displayed

Definition at line 89 of file dotcode.py.


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


rocon_gateway_graph
Author(s): Daniel Stonier
autogenerated on Fri Feb 12 2016 02:50:08