rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator Class Reference

List of all members.

Public Member Functions
def	__init__
def	add_package_ancestors_recursively
def	add_package_descendants_recursively
def	generate
def	generate_dotcode
Public Attributes
	ancestors
	colortheme
	depth
	descendants
	dotcode
	dotcode_factory
	edges
	excludes
	graph
	hide_transitives
	last_drawargs
	last_selection
	mark_selected
	packages
	rank
	rankdir
	ranksep
	rospack
	rosstack
	selected_names
	simplify
	stacks
	with_stacks
Private Member Functions
def	_add_edge
def	_add_package
def	_add_stack
def	_generate_package

---

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 246 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 225 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._add_stack	(		self,
			stackname
	)		[private]

Definition at line 220 of file dotcode_pack.py.

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator._generate_package	(		self,
			dotcode_factory,
			graph,
			package_name
	)		[private]

Definition at line 214 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 249 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 287 of file dotcode_pack.py.

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

Definition at line 177 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,
			mark_selected = True,
			colortheme = None,
			rank = 'same',
			ranksep = 0.2,
			rankdir = 'TB',
			simplify = True,
			force_refresh = False
	)

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

Definition at line 68 of file dotcode_pack.py.

---

Member Data Documentation

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::ancestors

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::colortheme

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::depth

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::descendants

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::dotcode

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::dotcode_factory

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::edges

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::excludes

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::graph

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::hide_transitives

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::last_drawargs

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::last_selection

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::mark_selected

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::packages

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::rank

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::rankdir

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::ranksep

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::rospack

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::rosstack

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::selected_names

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::simplify

Definition at line 71 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::stacks

Definition at line 58 of file dotcode_pack.py.

rqt_dep::dotcode_pack.RosPackageGraphDotcodeGenerator::with_stacks

Definition at line 71 of file dotcode_pack.py.

---

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

• dotcode_pack.py