Public Member Functions
def	__init__ (self)

def	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, unreachable=False, hide_tf_nodes=False, group_tf_nodes=False, group_image_nodes=False, hide_dynamic_reconfigure=False)

def	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, unreachable=False, group_tf_nodes=False, hide_tf_nodes=False, group_image_nodes=False, hide_dynamic_reconfigure=False)

def	generate_namespaces (self, graph, graph_mode, quiet=False)

def	quiet_filter_topic_edge (self, edge)

def	statistics_callback (self, msg)

Public Attributes
	stats_sub

Static Public Attributes
	edges = dict([])

	nodes = dict([])

Private Member Functions
def	_accumulate_action_topics (self, nodes_in, edges_in, node_connections)

def	_accumulate_image_topics (self, nodes_in, edges_in, node_connections)

def	_add_edge (self, edge, dotcode_factory, dotgraph, is_topic=False)

def	_add_node (self, node, rosgraphinst, dotcode_factory, dotgraph, unreachable)

def	_add_topic_node (self, node, dotcode_factory, dotgraph, quiet)

def	_add_topic_node_group (self, node, dotcode_factory, dotgraph, quiet)

def	_calc_edge_color (self, sub, topic, pub=None)

def	_calc_edge_penwidth (self, sub, topic, pub=None)

def	_calc_statistic_info (self, sub, topic, pub=None)

def	_filter_hidden_topics (self, nodes_in, edges_in, node_connections, hide_tf_nodes, hide_dynamic_reconfigure)

def	_filter_leaf_topics (self, nodes_in, edges_in, node_connections, hide_single_connection_topics, hide_dead_end_topics)

def	_filter_orphaned_edges (self, edges, nodes)

def	_filter_orphaned_topics (self, nt_nodes, edges)

def	_get_max_age (self)

def	_get_max_age_on_topic (self, sub, topic)

def	_get_max_traffic (self)

def	_get_node_edge_map (self, edges)

def	_group_tf_nodes (self, nodes_in, edges_in, node_connections)

def	_populate_node_graph (self, cluster_namespaces_level, node_list, dotcode_factory, dotgraph, rank, orientation, simplify)

def	_quiet_filter (self, name)

def	_split_filter_string (self, ns_filter)

Detailed Description

Definition at line 91 of file dotcode.py.

Constructor & Destructor Documentation

◆ init()

def rqt_graph.dotcode.RosGraphDotcodeGenerator.__init__ ( self )

Definition at line 99 of file dotcode.py.

Member Function Documentation

◆ _accumulate_action_topics()

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

◆ _accumulate_image_topics()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._accumulate_image_topics	(	self,
		nodes_in,
		edges_in,
		node_connections
	)

private

takes topic nodes, edges and node connections.
Returns topic nodes where image topics have been removed,
edges where the edges to image topics have been removed, and
a map with the connection to each virtual image topic node

Definition at line 550 of file dotcode.py.

◆ _add_edge()

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

private

Definition at line 212 of file dotcode.py.

◆ _add_node()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._add_node	(	self,
		node,
		rosgraphinst,
		dotcode_factory,
		dotgraph,
		unreachable
	)

private

Definition at line 252 of file dotcode.py.

◆ _add_topic_node()

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

private

Definition at line 289 of file dotcode.py.

◆ _add_topic_node_group()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._add_topic_node_group	(	self,
		node,
		dotcode_factory,
		dotgraph,
		quiet
	)

private

Definition at line 298 of file dotcode.py.

◆ _calc_edge_color()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_edge_color	(	self,
		sub,
		topic,
		pub = `None`
	)

private

Definition at line 141 of file dotcode.py.

◆ _calc_edge_penwidth()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_edge_penwidth	(	self,
		sub,
		topic,
		pub = `None`
	)

private

Definition at line 172 of file dotcode.py.

◆ _calc_statistic_info()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._calc_statistic_info	(	self,
		sub,
		topic,
		pub = `None`
	)

private

Definition at line 184 of file dotcode.py.

◆ _filter_hidden_topics()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._filter_hidden_topics	(	self,
		nodes_in,
		edges_in,
		node_connections,
		hide_tf_nodes,
		hide_dynamic_reconfigure
	)

private

Definition at line 589 of file dotcode.py.

◆ _filter_leaf_topics()

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

◆ _filter_orphaned_edges()

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

private

Definition at line 347 of file dotcode.py.

◆ _filter_orphaned_topics()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._filter_orphaned_topics	(	self,
		nt_nodes,
		edges
	)

private

remove topic graphnodes without connected ROS nodes

Definition at line 352 of file dotcode.py.

◆ _get_max_age()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._get_max_age ( self )

private

Definition at line 127 of file dotcode.py.

◆ _get_max_age_on_topic()

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

private

Definition at line 135 of file dotcode.py.

◆ _get_max_traffic()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._get_max_traffic ( self )

private

Definition at line 119 of file dotcode.py.

◆ _get_node_edge_map()

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

◆ _group_tf_nodes()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._group_tf_nodes	(	self,
		nodes_in,
		edges_in,
		node_connections
	)

private

takes topic nodes, edges and node connections.
Returns topic nodes where tf topics have been removed,
edges where the edges to tf topics have been removed, and
a map with all the connections to the resulting tf group node

Definition at line 517 of file dotcode.py.

◆ _populate_node_graph()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._populate_node_graph	(	self,
		cluster_namespaces_level,
		node_list,
		dotcode_factory,
		dotgraph,
		rank,
		orientation,
		simplify
	)

private

Definition at line 472 of file dotcode.py.

◆ _quiet_filter()

def rqt_graph.dotcode.RosGraphDotcodeGenerator._quiet_filter	(	self,
		name
	)

private

Definition at line 307 of file dotcode.py.

◆ _split_filter_string()

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

◆ generate_dotcode()

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`,
		unreachable = `False`,
		hide_tf_nodes = `False`,
		group_tf_nodes = `False`,
		group_image_nodes = `False`,
		hide_dynamic_reconfigure = `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 852 of file dotcode.py.

◆ generate_dotgraph()

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`,
		unreachable = `False`,
		group_tf_nodes = `False`,
		hide_tf_nodes = `False`,
		group_image_nodes = `False`,
		hide_dynamic_reconfigure = `False`
	)

See generate_dotcode

Definition at line 630 of file dotcode.py.

◆ generate_namespaces()

def rqt_graph.dotcode.RosGraphDotcodeGenerator.generate_namespaces	(	self,
		graph,
		graph_mode,
		quiet = `False`
	)

Determine the namespaces of the nodes being displayed

Definition at line 320 of file dotcode.py.

◆ quiet_filter_topic_edge()

def rqt_graph.dotcode.RosGraphDotcodeGenerator.quiet_filter_topic_edge	(	self,
		edge
	)

Definition at line 314 of file dotcode.py.

◆ statistics_callback()

def rqt_graph.dotcode.RosGraphDotcodeGenerator.statistics_callback	(	self,
		msg
	)

Definition at line 108 of file dotcode.py.

Member Data Documentation

◆ edges

rqt_graph.dotcode.RosGraphDotcodeGenerator.edges = dict([])

static

Definition at line 94 of file dotcode.py.

◆ nodes

rqt_graph.dotcode.RosGraphDotcodeGenerator.nodes = dict([])

static

Definition at line 97 of file dotcode.py.

◆ stats_sub

rqt_graph.dotcode.RosGraphDotcodeGenerator.stats_sub

Definition at line 102 of file dotcode.py.

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

dotcode.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _accumulate_action_topics()

◆ _accumulate_image_topics()

◆ _add_edge()

◆ _add_node()

◆ _add_topic_node()

◆ _add_topic_node_group()

◆ _calc_edge_color()

◆ _calc_edge_penwidth()

◆ _calc_statistic_info()

◆ _filter_hidden_topics()

◆ _filter_leaf_topics()

◆ _filter_orphaned_edges()

◆ _filter_orphaned_topics()

◆ _get_max_age()

◆ _get_max_age_on_topic()

◆ _get_max_traffic()

◆ _get_node_edge_map()

◆ _group_tf_nodes()

◆ _populate_node_graph()

◆ _quiet_filter()

◆ _split_filter_string()

◆ generate_dotcode()

◆ generate_dotgraph()

◆ generate_namespaces()

◆ quiet_filter_topic_edge()

◆ statistics_callback()

Member Data Documentation

◆ edges

◆ nodes

◆ stats_sub

◆ init()