Warning: do not use this library. It is unstable and most of the routines here have been superseded by other libraries (e.g. rospkg). These routines will likely be deleted in future releases.
Exception |
|
Undocumented |
Exception |
|
Undocumented |
Function | expand |
Expand names into a list of packages. Names can either be of packages or stacks. |
Function | get |
Get the directory of a ROS stack. This will initialize an internal cache and return cached results if possible. |
Function | get |
@param env: override environment variables @type env: {str: str} |
Function | get |
Get stack version where stack_dir points to root directory of stack. |
Function | list |
Get list of all ROS stacks. This uses an internal cache. |
Function | list |
List ROS stacks within the specified path. |
Function | stack |
@param env: override environment variables @type env: {str: str} @return: name of stack that pkg is in, or None if pkg is not part of a stack @rtype: str @raise roslib.packages.InvalidROSPkgException: if pkg cannot be located... |
Constant | ROS |
Undocumented |
Constant | STACK |
Undocumented |
Function | _get |
Undocumented |
Function | _init |
Undocumented |
Variable | _ros |
Undocumented |
Variable | _rosstack |
Undocumented |
Expand names into a list of packages. Names can either be of packages or stacks.
@param names: names of stacks or packages @type names: [str] @return: ([packages], [not_found]). expand_packages() returns two lists. The first is of packages names. The second is a list of names for which no matching stack or package was found. Lists may have duplicates. @rtype: ([str], [str])
Get the directory of a ROS stack. This will initialize an internal cache and return cached results if possible.
This routine is not thread-safe to os.environ changes.
@param env: override environment variables @type env: {str: str} @param stack: name of ROS stack to locate on disk @type stack: str @return: directory of stack. @rtype: str @raise InvalidROSStackException: if stack cannot be located.
@param env: override environment variables @type env: {str: str}
@return: version number of stack, or None if stack is unversioned. @rtype: str
Get stack version where stack_dir points to root directory of stack.
@param env: override environment variables @type env: {str: str}
@return: version number of stack, or None if stack is unversioned. @rtype: str
Get list of all ROS stacks. This uses an internal cache.
This routine is not thread-safe to os.environ changes.
@param env: override environment variables @type env: {str: str} @return: complete list of stacks names in ROS environment @rtype: [str]
List ROS stacks within the specified path.
Optionally, a cache dictionary can be provided, which will be updated with the stack->path mappings. list_stacks_by_path() does NOT returned cached results -- it only updates the cache.
@param path: path to list stacks in @type path: str @param stacks: list of stacks to append to. If stack is
already present in stacks, it will be ignored.
@type stacks: [str] @param cache: (optional) stack path cache to update. Maps stack name to directory path. @type cache: {str: str} @return: complete list of stack names in ROS environment. Same as stacks parameter. @rtype: [str]