class documentation

class MasterProxy(object):

Constructor: MasterProxy(uri)

View In Hierarchy

Convenience wrapper for ROS master API and XML-RPC implementation. The Master API methods can be invoked on this object and will be forwarded appropriately. Names in arguments will be remapped according to current node settings. Provides dictionary-like access to parameter server, e.g.:

master[key] = value

All methods are thread-safe.

Method __contains__ Check if parameter is set on Parameter Server @param key: parameter key @type key: str @raise ROSException: if parameter server reports an error
Method __delitem__ Delete parameter key from the parameter server. @raise KeyError: if key is not set @raise ROSException: if parameter server reports an error
Method __getattr__ Undocumented
Method __getitem__ Fetch item from parameter server and subscribe to future updates so that values can be cached. @param key: parameter key @type key: str @raise KeyError: if key is not set
Method __init__ Constructor for wrapping a remote master instance. @param uri: XML-RPC URI of master @type uri: str
Method __iter__ @raise ROSException: if parameter server reports an error
Method __setitem__ Set parameter value on Parameter Server @param key: parameter key @type key: str @param val: parameter value @type val: XMLRPC legal value
Method get_param_cached Undocumented
Method search_param Search for a parameter matching key on the parameter server @return: found key or None if search did not succeed @rtype: str @raise ROSException: if parameter server reports an error
Instance Variable target Undocumented
def __contains__(self, key):

Check if parameter is set on Parameter Server @param key: parameter key @type key: str @raise ROSException: if parameter server reports an error

def __delitem__(self, key):

Delete parameter key from the parameter server. @raise KeyError: if key is not set @raise ROSException: if parameter server reports an error

def __getattr__(self, key):

Undocumented

def __getitem__(self, key):

Fetch item from parameter server and subscribe to future updates so that values can be cached. @param key: parameter key @type key: str @raise KeyError: if key is not set

def __init__(self, uri):

Constructor for wrapping a remote master instance. @param uri: XML-RPC URI of master @type uri: str

def __iter__(self):

@raise ROSException: if parameter server reports an error

def __setitem__(self, key, val):

Set parameter value on Parameter Server @param key: parameter key @type key: str @param val: parameter value @type val: XMLRPC legal value

def get_param_cached(self, key):

Undocumented

def search_param(self, key):

Search for a parameter matching key on the parameter server @return: found key or None if search did not succeed @rtype: str @raise ROSException: if parameter server reports an error

target =

Undocumented