All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends
Public Member Functions | Public Attributes | Private Member Functions
rocon_gateway.pulled_interface.PulledInterface Class Reference

Pulled Interface. More...

Inheritance diagram for rocon_gateway.pulled_interface.PulledInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def list_remote_gateway_names
 Pulled Interface Specific Methods.
def update

Public Attributes

 pull_all
 pulled
 unpull_all

Private Member Functions

def _generatePulls
 Utility Methods.

Detailed Description

Pulled Interface.

  The flipped interface is the set of rules 
  (pubs/subs/services/actions) and rules controlling flips
  to other gateways. 

Definition at line 25 of file pulled_interface.py.


Constructor & Destructor Documentation

def rocon_gateway.pulled_interface.PulledInterface.__init__ (   self,
  default_rule_blacklist,
  default_rules,
  all_targets 
)
  Initialises the flipped interface.

  @param default_rule_blacklist : used when in flip all mode
  @type dictionary of gateway
  @param default_rules : static rules to pull on startup
  @type gateway_msgs.msg.RemoteRule[]
  @param all_targets : static pull all targets to pull to on startup
  @type string[]

Reimplemented from rocon_gateway.interactive_interface.InteractiveInterface.

Definition at line 31 of file pulled_interface.py.


Member Function Documentation

def rocon_gateway.pulled_interface.PulledInterface._generatePulls (   self,
  type,
  name,
  node,
  gateway,
  unique_name 
) [private]

Utility Methods.

  Checks if a local rule (obtained from master.getSystemState) 
  is a suitable association with any of the rules or patterns. This can
  return multiple matches, since the same local rule 
  properties can be multiply flipped to different remote gateways.
    
  Used in the update() call above that is run in the watcher thread.
  
  Note, don't need to lock here as the update() function takes care of it.
  
  @param type : rule type
  @type str : string constant from gateway_msgs.msg.Rule
  
  @param name : fully qualified topic, service or action name
  @type str
  
  @param node : ros node name (coming from master.getSystemState)
  @type str
  
  @return all the pull rules that match this local rule
  @return list of RemoteRule objects updated with node names from self.watchlist

Definition at line 97 of file pulled_interface.py.

Pulled Interface Specific Methods.

  Collects all gateways that it should watch for (i.e. those 
  currently handled by existing registrations).
  
  @return set of gateway string ids
  @rtype set of string

Definition at line 147 of file pulled_interface.py.

def rocon_gateway.pulled_interface.PulledInterface.update (   self,
  connections,
  gateway,
  unique_name 
)
  Computes a new pulled interface from the incoming connections list
   and returns two dictionaries -
  removed and newly added pulls so the watcher thread can take
  appropriate action ((un)registrations).

  This is run in the watcher thread (warning: take care - other
  additions come from ros service calls in different threads!)

Definition at line 49 of file pulled_interface.py.


Member Data Documentation

Definition at line 40 of file pulled_interface.py.

Definition at line 40 of file pulled_interface.py.

Definition at line 40 of file pulled_interface.py.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Friends


rocon_gateway
Author(s): Daniel Stonier, Jihoon Lee,
autogenerated on Tue Jan 15 2013 17:43:24