niryo_libraries.roswtf.context.WtfContext

class documentation

class WtfContext(object):

View In Hierarchy

WtfContext stores common state about the ROS filesystem and online environment. The primary use of this is for convenience (not having to load this state manually) and performance (not having to do the same calculation repeatedly).

Static Method from_env Initialize WtfContext from environment.
Static Method from_package Initialize WtfContext from package name.
Static Method from_roslaunch @param roslaunch_file: roslaunch_file to load from @type roslaunch_file: str
Static Method from_stack Initialize WtfContext from stack. @param stack: stack name @type stack: str @raise WtfException: if context state cannot be initialized
Method __init__ Undocumented
Method as_dictionary @return: dictionary representation of context, which is useful for producing error messages @rtype: dict
Class Variable __slots__ Undocumented
Instance Variable actual_edges Undocumented
Instance Variable env Undocumented
Instance Variable errors Undocumented
Instance Variable expected_edges Undocumented
Instance Variable launch_file_deps Undocumented
Instance Variable launch_file_missing_deps Undocumented
Instance Variable launch_files Undocumented
Instance Variable manifest Undocumented
Instance Variable manifest_file Undocumented
Instance Variable nodes Undocumented
Instance Variable pkg Undocumented
Instance Variable pkg_dir Undocumented
Instance Variable pkgs Undocumented
Instance Variable pythonpath Undocumented
Instance Variable ros_package_path Undocumented
Instance Variable ros_root Undocumented
Instance Variable roslaunch_uris Undocumented
Instance Variable rospack Undocumented
Instance Variable rosstack Undocumented
Instance Variable service_providers Undocumented
Instance Variable services Undocumented
Instance Variable stack Undocumented
Instance Variable stack_dir Undocumented
Instance Variable stacks Undocumented
Instance Variable system_state Undocumented
Instance Variable topics Undocumented
Instance Variable unconnected_subscriptions Undocumented
Instance Variable uri_node_map Undocumented
Instance Variable use_sim_time Undocumented
Instance Variable warnings Undocumented
@staticmethod
def from_env(env=None):

Initialize WtfContext from environment.

@raise WtfException: if context state cannot be initialized

@staticmethod
def from_package(pkg, env=None):

Initialize WtfContext from package name.

@param pkg: package name @type pkg: str @raise WtfException: if context state cannot be initialized

@staticmethod
def from_roslaunch(roslaunch_files, env=None):

@param roslaunch_file: roslaunch_file to load from @type roslaunch_file: str

@staticmethod
def from_stack(stack, env=None):

Initialize WtfContext from stack. @param stack: stack name @type stack: str @raise WtfException: if context state cannot be initialized

def __init__(self):

Undocumented

def as_dictionary(self):

@return: dictionary representation of context, which is useful for producing error messages @rtype: dict

__slots__: list[str] =

Undocumented

actual_edges =

Undocumented

env: dict =

Undocumented

errors: list =

Undocumented

expected_edges =

Undocumented

launch_file_deps =

Undocumented

launch_file_missing_deps =

Undocumented

launch_files =

Undocumented

manifest =

Undocumented

manifest_file =

Undocumented

nodes =

Undocumented

pkg =

Undocumented

pkg_dir =

Undocumented

pkgs: list =

Undocumented

pythonpath =

Undocumented

ros_package_path =

Undocumented

ros_root =

Undocumented

roslaunch_uris =

Undocumented

rospack =

Undocumented

rosstack =

Undocumented

service_providers =

Undocumented

services =

Undocumented

stack =

Undocumented

stack_dir =

Undocumented

stacks: list =

Undocumented

system_state =

Undocumented

topics =

Undocumented

unconnected_subscriptions =

Undocumented

uri_node_map: dict =

Undocumented

use_sim_time =

Undocumented

warnings: list =

Undocumented