Functions to handle getting system paths, keeps track of:
More...
#include <common/common.hh>
Inherits SingletonT< SystemPaths >.
Functions to handle getting system paths, keeps track of:
- SystemPaths::gazeboPaths - media paths containing worlds, models, sdf descriptions, material scripts, textures.
- SystemPaths::ogrePaths - ogre library paths. Should point to Ogre RenderSystem_GL.so et. al.
- SystemPaths::pluginPaths - plugin library paths for common::WorldPlugin
§ AddGazeboPaths()
| void AddGazeboPaths |
( |
const std::string & |
_path | ) |
|
Add colon delimited paths to Gazebo install.
- Parameters
-
| [in] | _path | the directory to add |
§ AddModelPaths()
| void AddModelPaths |
( |
const std::string & |
_path | ) |
|
Add colon delimited paths to modelPaths.
- Parameters
-
| [in] | _path | the directory to add |
§ AddModelPathsUpdate()
| void AddModelPathsUpdate |
( |
const std::string & |
_path | ) |
|
Add colon delimited paths to modelPaths and signal the update to InsertModelWidget.
- Parameters
-
| [in] | _path | Path to be added to the current model path |
§ AddOgrePaths()
| void AddOgrePaths |
( |
const std::string & |
_path | ) |
|
Add colon delimited paths to ogre install.
- Parameters
-
| [in] | _path | the directory to add |
§ AddPluginPaths()
| void AddPluginPaths |
( |
const std::string & |
_path | ) |
|
Add colon delimited paths to plugins.
- Parameters
-
| [in] | _path | the directory to add |
§ AddSearchPathSuffix()
| void AddSearchPathSuffix |
( |
const std::string & |
_suffix | ) |
|
add _suffix to the list of path search suffixes
- Parameters
-
| [in] | _suffix | The suffix to add |
§ ClearGazeboPaths()
| void ClearGazeboPaths |
( |
| ) |
|
clear out SystemPaths::gazeboPaths
§ ClearModelPaths()
clear out SystemPaths::modelPaths
§ ClearOgrePaths()
clear out SystemPaths::ogrePaths
§ ClearPluginPaths()
| void ClearPluginPaths |
( |
| ) |
|
clear out SystemPaths::pluginPaths
§ FindFile()
| std::string FindFile |
( |
const std::string & |
_filename, |
|
|
bool |
_searchLocalPath = true |
|
) |
| |
Find a file in the gazebo paths.
- Parameters
-
| [in] | _filename | Name of the file to find. |
| [in] | _searchLocalPath | True to search in the current working directory. |
- Returns
- Returns full path name to file
§ FindFileURI()
| std::string FindFileURI |
( |
const std::string & |
_uri | ) |
|
Find a file or path using a URI.
- Parameters
-
| [in] | _uri | the uniform resource identifier |
- Returns
- Returns full path name to file
§ GetDefaultTestPath()
| std::string GetDefaultTestPath |
( |
| ) |
|
Returns the default temporary test path.
- Returns
- a full path name to directory. E.g.: /tmp/gazebo_test (Linux).
§ GetGazeboPaths()
| const std::list<std::string>& GetGazeboPaths |
( |
| ) |
|
Get the gazebo install paths.
- Returns
- a list of paths
§ GetLogPath()
| std::string GetLogPath |
( |
| ) |
const |
Get the log path.
- Returns
- the path
§ GetModelPaths()
| const std::list<std::string>& GetModelPaths |
( |
| ) |
|
Get the model paths.
- Returns
- a list of paths
§ GetOgrePaths()
| const std::list<std::string>& GetOgrePaths |
( |
| ) |
|
Get the ogre install paths.
- Returns
- a list of paths
§ GetPluginPaths()
| const std::list<std::string>& GetPluginPaths |
( |
| ) |
|
Get the plugin paths.
- Returns
- a list of paths
§ GetTmpInstancePath()
| std::string GetTmpInstancePath |
( |
| ) |
|
Returns a unique temporary file for this instance of SystemPath.
- Returns
- a full path name to directory. E.g.: /tmp/gazebo_234123 (Linux).
§ GetTmpPath()
| std::string GetTmpPath |
( |
| ) |
|
Returns the default path suitable for temporary files.
- Returns
- a full path name to directory. E.g.: /tmp (Linux).
§ GetWorldPathExtension()
| std::string GetWorldPathExtension |
( |
| ) |
|
Returns the world path extension.
- Returns
- Right now, it just returns "/worlds"
§ Instance()
§ gazeboPathsFromEnv
§ modelPathsFromEnv
§ ogrePathsFromEnv
§ pluginPathsFromEnv
§ updateModelRequest
Event to notify InsertModelWidget that the model paths were changed.
The documentation for this class was generated from the following file:
