module documentation

Undocumented

Class ParamDictionary No class docstring; 0/3 instance variable, 9/9 methods documented
Function compute_param_updates Compute subscribers that should be notified based on the parameter update @param subscribers: parameter subscribers @type subscribers: Registrations @param param_key: parameter key @type param_key: str @param param_value: parameter value @type param_value: str @param caller_id_to_ignore: the caller to ignore @type caller_id_to_ignore: str...
Function _compute_all_keys Compute which subscribers should be notified based on the parameter update @param param_key: key of updated parameter @type param_key: str @param param_value: value of updated parameter @param all_keys: (internal use only) list of parameter keys...
Function _get_param_names helper recursive routine for getParamNames() @param names: list of param names to append to @type names: [str] @param d: parameter tree node @type d: dict @param key: parameter key for tree node d @type key: str...
def compute_param_updates(subscribers, param_key, param_value, caller_id_to_ignore=None):

Compute subscribers that should be notified based on the parameter update @param subscribers: parameter subscribers @type subscribers: Registrations @param param_key: parameter key @type param_key: str @param param_value: parameter value @type param_value: str @param caller_id_to_ignore: the caller to ignore @type caller_id_to_ignore: str

def _compute_all_keys(param_key, param_value, all_keys=None):

Compute which subscribers should be notified based on the parameter update @param param_key: key of updated parameter @type param_key: str @param param_value: value of updated parameter @param all_keys: (internal use only) list of parameter keys

to append to for recursive calls.

@type all_keys: [str] @return: list of parameter keys. All keys will be canonicalized with trailing slash. @rtype: [str]

def _get_param_names(names, key, d):

helper recursive routine for getParamNames() @param names: list of param names to append to @type names: [str] @param d: parameter tree node @type d: dict @param key: parameter key for tree node d @type key: str