rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator Class Reference

Public Member Functions
def	__init__ (self, rospack, rosstack)
def	add_package_ancestors_recursively (self, package_name, expanded_up=None, depth=None, implicit=False, parent=None)
def	add_package_descendants_recursively (self, package_name, expanded=None, depth=None, implicit=False, parent=None)
def	generate (self, dotcode_factory)
def	generate_dotcode (self, dotcode_factory, selected_names=[], excludes=[], depth=3, with_stacks=True, descendants=True, ancestors=True, hide_transitives=True, show_system=False, mark_selected=True, colortheme=None, rank='same', ranksep=0.2, rankdir='TB', simplify=True, force_refresh=False, hide_wet=False, hide_dry=False)

Public Attributes
	ancestors
	colortheme
	depth
	descendants
	dotcode
	dotcode_factory
	edges
	excludes
	graph
	hide_dry
	hide_transitives
	hide_wet
	last_drawargs
	last_selection
	mark_selected
	package_types
	packages
	rank
	rankdir
	ranksep
	rospack
	rosstack
	selected_names
	show_system
	simplify
	stacks
	traversed_ancestors
	traversed_descendants
	with_stacks

Private Member Functions
def	_add_edge (self, name1, name2, attributes=None)
def	_add_package (self, package_name, parent=None)
def	_add_stack (self, stackname)
def	_generate_package (self, dotcode_factory, graph, package_name, attributes=None)
def	_hide_package (self, package_name)
def	_is_package_wet (self, package_name)

Detailed Description

Definition at line 53 of file dotcode_pack.py.

Constructor & Destructor Documentation

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.__init__	(		self,
			rospack,
			rosstack
	)

:param rospack: use rospkg.RosPack()
:param rosstack: use rospkg.RosStack()

Definition at line 55 of file dotcode_pack.py.

Member Function Documentation

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._add_edge (   self,   name1,   name2,   attributes = None  )

private

Definition at line 311 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._add_package (   self,   package_name,   parent = None  )

private

adds object based on package_name to self.packages
:param parent: packagename which referenced package_name (for debugging only)

Definition at line 261 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._add_stack (   self,   stackname  )

private

Definition at line 256 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._generate_package (   self,   dotcode_factory,   graph,   package_name,   attributes = None  )

private

Definition at line 238 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._hide_package (   self,   package_name  )

private

Definition at line 290 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._is_package_wet (   self,   package_name  )

private

Definition at line 301 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.add_package_ancestors_recursively	(		self,
			package_name,
			expanded_up = None,
			depth = None,
			implicit = False,
			parent = None
	)

:param package_name: the name of package for which to add ancestors
:param expanded_up: names that have already been expanded (to avoid cycles)
:param depth: how many layers to follow
:param implicit: arg to rospack
:param parent: package that referenced package_name for error message only

Definition at line 318 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.add_package_descendants_recursively	(		self,
			package_name,
			expanded = None,
			depth = None,
			implicit = False,
			parent = None
	)

Definition at line 368 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.generate	(		self,
			dotcode_factory
	)

Definition at line 202 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.generate_dotcode	(		self,
			dotcode_factory,
			selected_names = [],
			excludes = [],
			depth = 3,
			with_stacks = True,
			descendants = True,
			ancestors = True,
			hide_transitives = True,
			show_system = False,
			mark_selected = True,
			colortheme = None,
			rank = 'same',
			ranksep = 0.2,
			rankdir = 'TB',
			simplify = True,
			force_refresh = False,
			hide_wet = False,
			hide_dry = False
	)

:param hide_transitives:
    if true, then dependency of children to grandchildren will be hidden if parent has
    same dependency
:param show_system: if true, then system dependencies will be shown

Definition at line 89 of file dotcode_pack.py.

Member Data Documentation

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.ancestors

Definition at line 136 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.colortheme

Definition at line 191 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.depth

Definition at line 103 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.descendants

Definition at line 137 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.dotcode

Definition at line 198 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.dotcode_factory

Definition at line 129 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.edges

Definition at line 65 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.excludes

Definition at line 135 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.graph

Definition at line 197 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_dry

Definition at line 139 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_transitives

Definition at line 132 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_wet

Definition at line 138 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.last_drawargs

Definition at line 68 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.last_selection

Definition at line 69 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.mark_selected

Definition at line 193 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.package_types

Definition at line 64 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.packages

Definition at line 63 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rank

Definition at line 187 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rankdir

Definition at line 188 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.ranksep

Definition at line 189 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rospack

Definition at line 60 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rosstack

Definition at line 61 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.selected_names

Definition at line 134 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.show_system

Definition at line 133 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.simplify

Definition at line 190 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.stacks

Definition at line 62 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.traversed_ancestors

Definition at line 66 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.traversed_descendants

Definition at line 67 of file dotcode_pack.py.

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.with_stacks

Definition at line 130 of file dotcode_pack.py.

---

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

• dotcode_pack.py