All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
gazebo::common::SystemPaths Class Reference

Functions to handle getting system paths, keeps track of: More...

#include <common/common.hh>

Inheritance diagram for gazebo::common::SystemPaths:
Inheritance graph
[legend]
Collaboration diagram for gazebo::common::SystemPaths:
Collaboration graph
[legend]

Public Member Functions

void AddGazeboPaths (const std::string &_path)
 Add colon delimited paths to Gazebo install. More...
 
void AddModelPaths (const std::string &_path)
 Add colon delimited paths to modelPaths. More...
 
void AddOgrePaths (const std::string &_path)
 Add colon delimited paths to ogre install. More...
 
void AddPluginPaths (const std::string &_path)
 Add colon delimited paths to plugins. More...
 
void AddSearchPathSuffix (const std::string &_suffix)
 add _suffix to the list of path search suffixes More...
 
void ClearGazeboPaths ()
 clear out SystemPaths::gazeboPaths More...
 
void ClearModelPaths ()
 clear out SystemPaths::modelPaths More...
 
void ClearOgrePaths ()
 clear out SystemPaths::ogrePaths More...
 
void ClearPluginPaths ()
 clear out SystemPaths::pluginPaths More...
 
std::string FindFile (const std::string &_filename, bool _searchLocalPath=true)
 Find a file in the gazebo paths. More...
 
std::string FindFileURI (const std::string &_uri)
 Find a file or path using a URI. More...
 
std::string GetDefaultTestPath ()
 Returns the default temporary test path. More...
 
const std::list< std::string > & GetGazeboPaths ()
 Get the gazebo install paths. More...
 
std::string GetLogPath () const
 Get the log path. More...
 
const std::list< std::string > & GetModelPaths ()
 Get the model paths. More...
 
const std::list< std::string > & GetOgrePaths ()
 Get the ogre install paths. More...
 
const std::list< std::string > & GetPluginPaths ()
 Get the plugin paths. More...
 
std::string GetTmpInstancePath ()
 Returns a unique temporary file for this instance of SystemPath. More...
 
std::string GetTmpPath ()
 Returns the default path suitable for temporary files. More...
 
std::string GetWorldPathExtension ()
 Returns the world path extension. More...
 

Public Attributes

bool gazeboPathsFromEnv
 if true, call UpdateGazeboPaths() within GetGazeboPaths() More...
 
bool modelPathsFromEnv
 if true, call UpdateGazeboPaths() within GetGazeboPaths() More...
 
bool ogrePathsFromEnv
 if true, call UpdateOgrePaths() within GetOgrePaths() More...
 
bool pluginPathsFromEnv
 if true, call UpdatePluginPaths() within GetPluginPaths() More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SingletonT< SystemPaths >
static SystemPaths * Instance ()
 Get an instance of the singleton. More...
 
- Protected Member Functions inherited from SingletonT< SystemPaths >
 SingletonT ()
 Constructor. More...
 
virtual ~SingletonT ()
 Destructor. More...
 

Detailed Description

Functions to handle getting system paths, keeps track of:

Member Function Documentation

void gazebo::common::SystemPaths::AddGazeboPaths ( const std::string &  _path)

Add colon delimited paths to Gazebo install.

Parameters
[in]_paththe directory to add
void gazebo::common::SystemPaths::AddModelPaths ( const std::string &  _path)

Add colon delimited paths to modelPaths.

Parameters
[in]_paththe directory to add
void gazebo::common::SystemPaths::AddOgrePaths ( const std::string &  _path)

Add colon delimited paths to ogre install.

Parameters
[in]_paththe directory to add
void gazebo::common::SystemPaths::AddPluginPaths ( const std::string &  _path)

Add colon delimited paths to plugins.

Parameters
[in]_paththe directory to add
void gazebo::common::SystemPaths::AddSearchPathSuffix ( const std::string &  _suffix)

add _suffix to the list of path search suffixes

Parameters
[in]_suffixThe suffix to add
void gazebo::common::SystemPaths::ClearGazeboPaths ( )

clear out SystemPaths::gazeboPaths

void gazebo::common::SystemPaths::ClearModelPaths ( )

clear out SystemPaths::modelPaths

void gazebo::common::SystemPaths::ClearOgrePaths ( )

clear out SystemPaths::ogrePaths

void gazebo::common::SystemPaths::ClearPluginPaths ( )

clear out SystemPaths::pluginPaths

std::string gazebo::common::SystemPaths::FindFile ( const std::string &  _filename,
bool  _searchLocalPath = true 
)

Find a file in the gazebo paths.

Parameters
[in]_filenameName of the file to find.
[in]_searchLocalPathTrue to search in the current working directory.
Returns
Returns full path name to file
std::string gazebo::common::SystemPaths::FindFileURI ( const std::string &  _uri)

Find a file or path using a URI.

Parameters
[in]_urithe uniform resource identifier
Returns
Returns full path name to file
std::string gazebo::common::SystemPaths::GetDefaultTestPath ( )

Returns the default temporary test path.

Returns
a full path name to directory. E.g.: /tmp/gazebo_test (Linux).
const std::list<std::string>& gazebo::common::SystemPaths::GetGazeboPaths ( )

Get the gazebo install paths.

Returns
a list of paths
std::string gazebo::common::SystemPaths::GetLogPath ( ) const

Get the log path.

Returns
the path
const std::list<std::string>& gazebo::common::SystemPaths::GetModelPaths ( )

Get the model paths.

Returns
a list of paths
const std::list<std::string>& gazebo::common::SystemPaths::GetOgrePaths ( )

Get the ogre install paths.

Returns
a list of paths
const std::list<std::string>& gazebo::common::SystemPaths::GetPluginPaths ( )

Get the plugin paths.

Returns
a list of paths
std::string gazebo::common::SystemPaths::GetTmpInstancePath ( )

Returns a unique temporary file for this instance of SystemPath.

Returns
a full path name to directory. E.g.: /tmp/gazebo_234123 (Linux).
std::string gazebo::common::SystemPaths::GetTmpPath ( )

Returns the default path suitable for temporary files.

Returns
a full path name to directory. E.g.: /tmp (Linux).
std::string gazebo::common::SystemPaths::GetWorldPathExtension ( )

Returns the world path extension.

Returns
Right now, it just returns "/worlds"

Member Data Documentation

bool gazebo::common::SystemPaths::gazeboPathsFromEnv

if true, call UpdateGazeboPaths() within GetGazeboPaths()

bool gazebo::common::SystemPaths::modelPathsFromEnv

if true, call UpdateGazeboPaths() within GetGazeboPaths()

bool gazebo::common::SystemPaths::ogrePathsFromEnv

if true, call UpdateOgrePaths() within GetOgrePaths()

bool gazebo::common::SystemPaths::pluginPathsFromEnv

if true, call UpdatePluginPaths() within GetPluginPaths()


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