python.trfGraph.graphPath Class Reference

Path object holding a list of nodes and data types which trace a single path through the graph. More...

Inheritance diagram for python.trfGraph.graphPath:

Collaboration diagram for python.trfGraph.graphPath:

Public Member Functions
def	__init__ (self, endNodeName, data, cost=0)
	graphPath constructor More...
def	path (self)
def	cost (self)
def	newData (self)
def	extraData (self)
def	addToPath (self, newNodeName, newData=set(), extraData=set(), extraCost=0)
def	addCost (self, cost)
def	__str__ (self)

Private Attributes
	_path
	_data
	_cost
	_newData
	_extraData

Detailed Description

Path object holding a list of nodes and data types which trace a single path through the graph.

Definition at line 540 of file trfGraph.py.

Constructor & Destructor Documentation

__init__()

def python.trfGraph.graphPath.__init__	(		self,
			endNodeName,
			data,
			cost = 0
	)

graphPath constructor

Parameters

endNodeName	The node name where this path will end
data	The data type which this path will make
cost	The starting cost of this path (default 0)

Definition at line 546 of file trfGraph.py.

    def __init__(self, endNodeName, data, cost = 0):
        self._path = [endNodeName]
        self._data = data
        self._cost = cost
        
        
        self._newData = dict()
        self._extraData = dict()
        

Member Function Documentation

__str__()

def python.trfGraph.graphPath.__str__

(

self

)

Definition at line 583 of file trfGraph.py.

    def __str__(self):
        return '{0}: path {1}; cost {2}, newData {3}, extraData {4}'.format(self._data, self._path, self._cost, self._newData, self._extraData)
    

addCost()

def python.trfGraph.graphPath.addCost	(		self,
			cost
	)

Definition at line 580 of file trfGraph.py.

    def addCost(self, cost):
        self._cost += cost
        

addToPath()

def python.trfGraph.graphPath.addToPath	(		self,
			newNodeName,
			newData = set(),
			extraData = set(),
			extraCost = 0
	)

Definition at line 574 of file trfGraph.py.

    def addToPath(self, newNodeName, newData = set(), extraData = set(), extraCost = 0):
        self._path.insert(0, newNodeName)
        self._newData[newNodeName] = newData
        self._cost += extraCost
        self._extraData[newNodeName] = extraData
        

cost()

def python.trfGraph.graphPath.cost

(

self

)

Definition at line 563 of file trfGraph.py.

    def cost(self):
        return self._cost
    

extraData()

def python.trfGraph.graphPath.extraData

(

self

)

Definition at line 571 of file trfGraph.py.

    def extraData(self):
        return self._extraData
    

newData()

def python.trfGraph.graphPath.newData

(

self

)

Definition at line 567 of file trfGraph.py.

    def newData(self):
        return self._newData
    

path()

def python.trfGraph.graphPath.path

(

self

)

Definition at line 559 of file trfGraph.py.

    def path(self):
        return self._path
    

Member Data Documentation

_cost

python.trfGraph.graphPath._cost

private

Definition at line 549 of file trfGraph.py.

_data

python.trfGraph.graphPath._data

private

Definition at line 548 of file trfGraph.py.

_extraData

python.trfGraph.graphPath._extraData

private

Definition at line 556 of file trfGraph.py.

_newData

python.trfGraph.graphPath._newData

private

Note

These are dictionaries, keyed by substep, with the data which needs to be produced in that substep, i.e., it is the output data for that step and the input data for the downstream step. To avoid data duplication the values are sets. extraData gives data which is not made in this path itself, but is needed in order to satisfy multi-data entry criteria. newData is data which is produced along this path.

Definition at line 555 of file trfGraph.py.

_path

python.trfGraph.graphPath._path

private

Definition at line 547 of file trfGraph.py.

---

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

• trfGraph.py