Public Member Functions | Public Attributes | Private Member Functions | List of all members
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=None, excludes=None, 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

◆ __init__()

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

◆ _add_edge()

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

Definition at line 315 of file dotcode_pack.py.

◆ _add_package()

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

◆ _add_stack()

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

Definition at line 260 of file dotcode_pack.py.

◆ _generate_package()

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

Definition at line 242 of file dotcode_pack.py.

◆ _hide_package()

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

Definition at line 294 of file dotcode_pack.py.

◆ _is_package_wet()

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

Definition at line 305 of file dotcode_pack.py.

◆ add_package_ancestors_recursively()

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

◆ add_package_descendants_recursively()

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

Definition at line 370 of file dotcode_pack.py.

◆ generate()

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

Definition at line 206 of file dotcode_pack.py.

◆ generate_dotcode()

def rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.generate_dotcode (   self,
  dotcode_factory,
  selected_names = None,
  excludes = None,
  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 71 of file dotcode_pack.py.

Member Data Documentation

◆ ancestors

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.ancestors

Definition at line 122 of file dotcode_pack.py.

◆ colortheme

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.colortheme

Definition at line 177 of file dotcode_pack.py.

◆ depth

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.depth

Definition at line 89 of file dotcode_pack.py.

◆ descendants

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.descendants

Definition at line 123 of file dotcode_pack.py.

◆ dotcode

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.dotcode

Definition at line 184 of file dotcode_pack.py.

◆ dotcode_factory

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.dotcode_factory

Definition at line 115 of file dotcode_pack.py.

◆ edges

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.edges

Definition at line 65 of file dotcode_pack.py.

◆ excludes

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.excludes

Definition at line 121 of file dotcode_pack.py.

◆ graph

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.graph

Definition at line 183 of file dotcode_pack.py.

◆ hide_dry

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_dry

Definition at line 125 of file dotcode_pack.py.

◆ hide_transitives

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_transitives

Definition at line 118 of file dotcode_pack.py.

◆ hide_wet

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.hide_wet

Definition at line 124 of file dotcode_pack.py.

◆ last_drawargs

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.last_drawargs

Definition at line 68 of file dotcode_pack.py.

◆ last_selection

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.last_selection

Definition at line 69 of file dotcode_pack.py.

◆ mark_selected

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.mark_selected

Definition at line 179 of file dotcode_pack.py.

◆ package_types

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.package_types

Definition at line 64 of file dotcode_pack.py.

◆ packages

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.packages

Definition at line 63 of file dotcode_pack.py.

◆ rank

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rank

Definition at line 173 of file dotcode_pack.py.

◆ rankdir

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rankdir

Definition at line 174 of file dotcode_pack.py.

◆ ranksep

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.ranksep

Definition at line 175 of file dotcode_pack.py.

◆ rospack

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rospack

Definition at line 60 of file dotcode_pack.py.

◆ rosstack

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.rosstack

Definition at line 61 of file dotcode_pack.py.

◆ selected_names

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.selected_names

Definition at line 120 of file dotcode_pack.py.

◆ show_system

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.show_system

Definition at line 119 of file dotcode_pack.py.

◆ simplify

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.simplify

Definition at line 176 of file dotcode_pack.py.

◆ stacks

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.stacks

Definition at line 62 of file dotcode_pack.py.

◆ traversed_ancestors

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.traversed_ancestors

Definition at line 66 of file dotcode_pack.py.

◆ traversed_descendants

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.traversed_descendants

Definition at line 67 of file dotcode_pack.py.

◆ with_stacks

rqt_dep.dotcode_pack.RosPackageGraphDotcodeGenerator.with_stacks

Definition at line 116 of file dotcode_pack.py.


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


rqt_dep
Author(s): Aaron Blasdel, Dirk Thomas, Thibault Kruse
autogenerated on Wed Oct 4 2023 02:54:09