The Assimilation Project  based on Assimilation version 1.1.7.1474836767
cma.drawwithdot.DotGraph Class Reference
Inheritance diagram for cma.drawwithdot.DotGraph:
Collaboration diagram for cma.drawwithdot.DotGraph:

Public Member Functions

def __init__ (self, formatdict, dburl=None, dronelist=None, dictclass=FancyDictObj, options=None, executor_context=None)
 
def render_options (self)
 
def __iter__ (self)
 
def out (self, outfile=sys.stdout)
 
def __str__ (self)
 

Static Public Member Functions

def idname (nodeid)
 

Data Fields

 formatdict
 
 store
 
 nodeids
 
 dictclass
 
 options
 
 executor_context
 
 dronelist
 

Detailed Description

Class to format Assimilation graphs as 'dot' graphs

Definition at line 286 of file drawwithdot.py.

Constructor & Destructor Documentation

def cma.drawwithdot.DotGraph.__init__ (   self,
  formatdict,
  dburl = None,
  dronelist = None,
  dictclass = FancyDictObj,
  options = None,
  executor_context = None 
)
Initialization
Here are the main two things to understand:
    formatdict is a dict-like object which provides a format string
    for each kind of relationship and node.

    These format strings are then interpolated with the values
    from the relationship or node as filtered by @dictclass objects.
    The @dictclass object must behave like a dict. When format items
    are requested by a format in the formatdict, the dictclass object
    is expected to provide those values.
params:
    @formatdict - dictionary providing format strings for
          nodes and relationships
    @dburl - URL for opening the database
    @dronelist - a possibly-None list of drones to start from
    @dictclass - a dict-like class which can take a node or
    relationship as a parameter for its constructor
    along with extra keywords as the kw parameter.

Definition at line 291 of file drawwithdot.py.

Member Function Documentation

def cma.drawwithdot.DotGraph.__iter__ (   self)
def cma.drawwithdot.DotGraph.__str__ (   self)
Output nodes and relationships in a string.

Definition at line 414 of file drawwithdot.py.

References cma.drawwithdot.DotGraph.__iter__(), cma.AssimCclasses.pyConfigContext.__iter__(), and cma.AssimCclasses.pyPcapCapture.__iter__().

Here is the call graph for this function:

def cma.drawwithdot.DotGraph.idname (   nodeid)
static
def cma.drawwithdot.DotGraph.out (   self,
  outfile = sys.stdout 
)
Output nodes and relationships to the 'outfile'.

Definition at line 410 of file drawwithdot.py.

References cma.drawwithdot.DotGraph.__iter__(), cma.AssimCclasses.pyConfigContext.__iter__(), and cma.AssimCclasses.pyPcapCapture.__iter__().

Here is the call graph for this function:

def cma.drawwithdot.DotGraph.render_options (   self)

Definition at line 361 of file drawwithdot.py.

References cma.drawwithdot.DotGraph.options.

Referenced by cma.drawwithdot.DotGraph.__iter__().

Here is the caller graph for this function:

Field Documentation

cma.drawwithdot.DotGraph.dictclass

Definition at line 314 of file drawwithdot.py.

Referenced by cma.drawwithdot.DotGraph.idname().

cma.drawwithdot.DotGraph.dronelist

Definition at line 318 of file drawwithdot.py.

Referenced by cma.drawwithdot.DotGraph.__iter__().

cma.drawwithdot.DotGraph.executor_context

Definition at line 316 of file drawwithdot.py.

Referenced by cma.drawwithdot.DotGraph.__iter__().

cma.drawwithdot.DotGraph.formatdict
cma.drawwithdot.DotGraph.nodeids

Definition at line 313 of file drawwithdot.py.

Referenced by cma.drawwithdot.DotGraph.idname().

cma.drawwithdot.DotGraph.options

Definition at line 315 of file drawwithdot.py.

Referenced by cma.drawwithdot.DotGraph.render_options().


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