concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator Class Reference

Implementation. More...

List of all members.

Public Member Functions
def	__init__
def	generate_dotcode
def	get_nodes_and_edges
Private Member Functions
def	_add_conductor_node
def	_add_edge
def	_add_node

---

Detailed Description

Implementation.

Definition at line 19 of file dotcode.py.

---

Constructor & Destructor Documentation

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator.__init__

(

self

)

Definition at line 21 of file dotcode.py.

---

Member Function Documentation

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator._add_conductor_node	(		self,
			dotcode_factory,
			dotgraph
	)		[private]

The conductor is a special case node, we treat this especially here.

Definition at line 30 of file dotcode.py.

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator._add_edge	(		self,
			edge,
			dotcode_factory,
			dotgraph
	)		[private]

Definition at line 24 of file dotcode.py.

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator._add_node	(		self,
			node,
			dotcode_factory,
			dotgraph
	)		[private]

A node here is a concert client. We basically add nodes and classify according
to their state in the dotgraph.

:param node .concert_client.ConcertClient: the concert client to show on the dotgraph

Definition at line 44 of file dotcode.py.

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator.generate_dotcode	(		self,
			conductor_graph_instance,
			dotcode_factory,
			clusters = False,
			uninvited_filter = False,
			orientation = 'LR',
			rank = 'same',
			ranksep = 0.2,
			rankdir = 'TB',
			simplify = True
	)

:param conductor_graph_instance ConductorGraphInfo: all the information behind the graph
:param dotcode_factory: abstract factory manipulating dot language objects
:param clusters bool: whether to show by ip clusters or not
:param uninvited_filter: disable viewing of uninvited clients
:param orientation: rankdir value (see ORIENTATIONS dict)
:param rank str: one of None, same, min, max, source, sink
:param ranksep float: vertical distance between layers
:param rankdir str: direction of layout (TB top > bottom, LR left > right)
:param simplify bool: remove double edges
:returns: dotcode generated from graph singleton
:rtype: str

Definition at line 99 of file dotcode.py.

def concert_utilities.conductor_graph.dotcode.ConductorGraphDotcodeGenerator.get_nodes_and_edges	(		self,
			conductor_graph_instance
	)

Get all the nodes and edges corresponding to our conductor's graph of concert clients.

:returns: all the nodes and edges
:rtype: (concert_client.ConcertClient[], rosgraph.impl.graph.Edge[])

Definition at line 81 of file dotcode.py.

---

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

• dotcode.py