ControlFlow.DotVisitor Class Reference

Public Member Functions
	__init__ (self)
	enter (self, visitee)
	leave (self, visitee)
	collapse_identical_ancestors (self, thetype)
	is_needed (self, visitee)
	write (self, filename)

Public Attributes
list	nodes = []
list	edges = []
int	number = 0
list	stack = []
dict	ids = {}

Detailed Description

Definition at line 249 of file ControlFlow.py.

Constructor & Destructor Documentation

__init__()

ControlFlow.DotVisitor.__init__

(

self

)

Definition at line 250 of file ControlFlow.py.

    def __init__(self):
        self.nodes = []
        self.edges = []
        self.number = 0
        self.stack = []
        self.ids = {}
 

Member Function Documentation

collapse_identical_ancestors()

ControlFlow.DotVisitor.collapse_identical_ancestors	(		self,
			thetype )

If AND nodes are inside AND nodes, the graph could be simplified
to not contain those (same true for OR and ordered)

Definition at line 292 of file ControlFlow.py.

    def collapse_identical_ancestors(self, thetype):
        """
        If AND nodes are inside AND nodes, the graph could be simplified
        to not contain those (same true for OR and ordered)
        """
        if len(self.stack) != 0:
            mother = self.stack[-1][1]
            for entry in self.stack[::-1]:
                if not isinstance(entry[0], thetype):
                    break
                mother = entry[1]
            return mother
        return None
 

enter()

ControlFlow.DotVisitor.enter	(		self,
			visitee )

Definition at line 257 of file ControlFlow.py.

    def enter(self, visitee):
        if visitee not in self.ids:
            self.number += 1
            dot_id = self.ids[visitee] = f"T{self.number}"
        dot_id = self.ids[visitee]
        mother = None
        if self.is_needed(visitee):
            if isinstance(visitee, ControlFlowLeaf):
                entry = f'{dot_id} [label="{visitee.name()}", shape=box]'
            elif isinstance(visitee, OrNode):
                entry = f'{dot_id} [label="OR", shape=invhouse]'
            elif isinstance(visitee, AndNode):
                entry = f'{dot_id} [label="AND", shape=invhouse]'
            elif isinstance(visitee, OrderedNode):
                entry = f'{dot_id} [label=">>", shape=point]'
            elif isinstance(visitee, InvertNode):
                entry = f'{dot_id} [label="NOT", shape=circle, color=red]'
            elif isinstance(visitee, par):
                entry = f'{dot_id} [label="PAR", shape=circle]'
            elif isinstance(visitee, seq):
                entry = f'{dot_id} [label="SEQ", shape=circle]'
            else:
                entry = f'{dot_id} [label="{type(visitee)}", shape=circle]'
            self.nodes.append(entry)
            if len(self.stack) != 0:
                mother = self.collapse_identical_ancestors(type(self.stack[-1][0]))
                if not mother:
                    mother = self.stack[-1][1]
                edge = f"{dot_id}->{mother}"
                self.edges.append(edge)
        self.stack.append((visitee, dot_id))
 

is_needed()

ControlFlow.DotVisitor.is_needed	(		self,
			visitee )

Check whether this node is actually needed

Definition at line 306 of file ControlFlow.py.

    def is_needed(self, visitee):
        """
        Check whether this node is actually needed
        """
        if len(self.stack) != 0:
            return not isinstance(visitee, type(self.stack[-1][0]))
        return True
 

leave()

ControlFlow.DotVisitor.leave	(		self,
			visitee )

Definition at line 289 of file ControlFlow.py.

    def leave(self, visitee):
        self.stack.pop()
 

write()

ControlFlow.DotVisitor.write	(		self,
			filename )

Definition at line 314 of file ControlFlow.py.

    def write(self, filename):
        output = """
digraph graphname {{
rankdir=LR
 
{}
 
{}
 
}}
""".format(
            "\n".join(self.nodes),
            "\n".join(self.edges),
        )
 
        with open(filename, "w") as outfile:
            outfile.write(output)
 
 

Member Data Documentation

edges

list ControlFlow.DotVisitor.edges = []

Definition at line 252 of file ControlFlow.py.

ids

dict ControlFlow.DotVisitor.ids = {}

Definition at line 255 of file ControlFlow.py.

nodes

list ControlFlow.DotVisitor.nodes = []

Definition at line 251 of file ControlFlow.py.

number

int ControlFlow.DotVisitor.number = 0

Definition at line 253 of file ControlFlow.py.

stack

ControlFlow.DotVisitor.stack = []

Definition at line 254 of file ControlFlow.py.

---

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

• GaudiKernel/python/GaudiConfig/ControlFlow.py