librospack
Public Member Functions | List of all members
rospack::Rosstack Class Reference

Stack crawler. Create one of these to operate on a stack tree. Call public methods inherited from Rosstackage. More...

#include <rospack.h>

Inheritance diagram for rospack::Rosstack:
rospack::Rosstackage

Public Member Functions

 Rosstack ()
 Constructor.
 
virtual const char * usage ()
 Usage statement. More...
 
- Public Member Functions inherited from rospack::Rosstackage
virtual ~Rosstackage ()
 Destructor.
 
void crawl (std::vector< std::string > search_path, bool force)
 Crawl the filesystem, accumulating a database of stackages. May read results from a cache file instead of crawling. This method should be called before any making any queries (find, list, etc.). More...
 
bool inStackage (std::string &name)
 Is the current working directory a stackage? More...
 
void setQuiet (bool quiet)
 Control warning and error console output. More...
 
const std::string & getName ()
 Get the name of the tool that's in use (e.g., "rospack" or "rosstack") More...
 
bool getSearchPathFromEnv (std::vector< std::string > &sp)
 Helper method to construct a directory search path by looking at relevant environment variables. The value of ROS_ROOT goes first, followed by each element of a colon-separated ROS_PACKAGE_PATH. More...
 
bool find (const std::string &name, std::string &path)
 Look for a stackage. More...
 
bool contents (const std::string &name, std::set< std::string > &packages)
 Compute the packages that are contained in a stack. More...
 
bool contains (const std::string &name, std::string &stack, std::string &path)
 Find the stack that contains a package. More...
 
void list (std::set< std::pair< std::string, std::string > > &list)
 List names and paths of all stackages. More...
 
void listDuplicates (std::vector< std::string > &dups)
 Identify duplicate stackages. Forces crawl. More...
 
bool deps (const std::string &name, bool direct, std::vector< std::string > &deps)
 Compute dependencies of a stackage (i.e., stackages that this stackages depends on). More...
 
bool depsOn (const std::string &name, bool direct, std::vector< std::string > &deps)
 Compute reverse dependencies of a stackage (i.e., stackages that depend on this stackage). Forces crawl. More...
 
bool depsManifests (const std::string &name, bool direct, std::vector< std::string > &manifests)
 List the manifests of a stackage's dependencies. Used by rosbuild. More...
 
bool depsMsgSrv (const std::string &name, bool direct, std::vector< std::string > &gens)
 List the marker files in a packages's dependencies that indicate that those packages contain auto-generated message and/or service code. Used by rosbuild. More...
 
bool depsIndent (const std::string &name, bool direct, std::vector< std::string > &deps)
 Generate indented list of a stackage's dependencies, including duplicates. Intended for visual debugging of dependency structures. More...
 
bool depsWhy (const std::string &from, const std::string &to, std::string &output)
 Compute all dependency chains from one stackage to another. Intended for visual debugging of dependency structures. More...
 
bool rosdeps (const std::string &name, bool direct, std::set< std::string > &rosdeps)
 Compute rosdep entries that are declared in manifest of a package and its dependencies. Used by rosmake. More...
 
bool vcs (const std::string &name, bool direct, std::vector< std::string > &vcs)
 Compute vcs entries that are declared in manifest of a package and its dependencies. Was used by Hudson build scripts; might not be needed. More...
 
bool exports (const std::string &name, const std::string &lang, const std::string &attrib, bool deps_only, std::vector< std::string > &flags)
 Compute exports declared in a package and its dependencies. Used by rosbuild. More...
 
bool plugins (const std::string &name, const std::string &attrib, const std::string &top, std::vector< std::string > &flags)
 Compute exported plugins declared in packages that depend on a package. Forces crawl. Used by rosbuild and roslib. More...
 
bool profile (const std::vector< std::string > &search_path, bool zombie_only, int length, std::vector< std::string > &dirs)
 Report on time taken to crawl for stackages. Intended for use in debugging misconfigured stackage trees. Forces crawl. More...
 
void logWarn (const std::string &msg, bool append_errno=false)
 Log a warning (usually goes to stderr). More...
 
void logError (const std::string &msg, bool append_errno=false)
 Log a error (usually goes to stderr). More...
 

Additional Inherited Members

- Protected Member Functions inherited from rospack::Rosstackage
 Rosstackage (const std::string &manifest_name, const std::string &cache_name, const std::string &name, const std::string &tag)
 Constructor, only used by derived classes. More...
 

Detailed Description

Stack crawler. Create one of these to operate on a stack tree. Call public methods inherited from Rosstackage.

Member Function Documentation

◆ usage()

virtual const char* rospack::Rosstack::usage ( )
virtual

Usage statement.

Returns
Command-line usage for the rosstack tool.

Reimplemented from rospack::Rosstackage.


The documentation for this class was generated from the following file: