Public Member Functions | Properties | Private Member Functions | Private Attributes
diarc.diarc.topology.Snap Class Reference

List of all members.

Public Member Functions

def __init__
def bandLinks
def block
def connection
def isLinked
def isSink
def isSource
def isUsed
def leftSnap
def negBandLink
def posBandLink
def rightSnap
def snapkey

Properties

 order = property(__get_order,__set_order)

Private Member Functions

def __get_order
def __set_order
def _release

Private Attributes

 _connection
 _order

Detailed Description

Visual Representation of a Source or Sink.
Snaps are layedout horizontally inside of an Emitter or Collector of a Block.
A Snap provides a mapping between a Source/Sink and one or two Bands associated with a single Edge.
Visual Layout Paramters
Order - 0-indexed order in which to draw snaps within an Emitter or Collector 

Definition at line 647 of file topology.py.


Constructor & Destructor Documentation

def diarc.diarc.topology.Snap.__init__ (   self,
  connection 
)

Definition at line 654 of file topology.py.


Member Function Documentation

def diarc.diarc.topology.Snap.__get_order (   self) [private]

Definition at line 760 of file topology.py.

def diarc.diarc.topology.Snap.__set_order (   self,
  value 
) [private]
Check to see if a snap with the same order already exists 

Definition at line 762 of file topology.py.

def diarc.diarc.topology.Snap._release (   self) [private]
This should only be called by a Connection.release() 

Definition at line 662 of file topology.py.

Definition at line 716 of file topology.py.

Definition at line 708 of file topology.py.

Definition at line 712 of file topology.py.

returns true if this snap is connected to at least one sink, else false. 

Definition at line 725 of file topology.py.

Definition at line 722 of file topology.py.

Definition at line 719 of file topology.py.

returns true if topology.hide_disconnected_snaps is True and isLinked is True, 
or if topology.hide_disconnected_snaps is false. Otherwise, return true.

Definition at line 729 of file topology.py.

Returns the snap directly to the left of this snap within either an 
emitter or collector. Returns None if this is leftmost snap. 

Definition at line 739 of file topology.py.

returns the negative band connection - if it exists. See posBand for
more details.

Definition at line 691 of file topology.py.

returns the positive band connection - if it exists. 
Just because a positive band link exists does not mean that it should
be drawn. The check for if we should draw the connection happens at drawing
time when we decide if we should be using positive or negative

Definition at line 672 of file topology.py.

Returns the snap directly to the right of this snap within either 
an emitter or collector. Returns None if this is rightmost snap.

Definition at line 750 of file topology.py.

generates the snapkey for this snap 

Definition at line 658 of file topology.py.


Member Data Documentation

Definition at line 654 of file topology.py.

Definition at line 654 of file topology.py.


Property Documentation

Definition at line 782 of file topology.py.


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


rqt_graphprofiler
Author(s): Dan Brooks
autogenerated on Thu Jun 6 2019 20:29:31