SystemPaths Class Reference

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

#include <common/common.hh>

Inherits SingletonT< SystemPaths >.

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	AddModelPathsUpdate (const std::string &_path)
	Add colon delimited paths to modelPaths and signal the update to InsertModelWidget. 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	DefaultTestPath () const
	Returns the default temporary test path. 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...
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	GetWorldPathExtension ()
	Returns the world path extension. More...
const std::string &	TmpInstancePath () const
	Returns a unique temporary file for this instance of SystemPath. More...
const std::string &	TmpPath () const
	Returns the default path suitable for temporary files. More...

Static Public Member Functions
static SystemPaths *	Instance ()
	Get an instance of the singleton. 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...
event::EventT< void(std::string)>	updateModelRequest
	Event to notify InsertModelWidget that the model paths were changed. More...

Detailed Description

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

Member Function Documentation

void AddGazeboPaths

(

const std::string &

_path

)

Add colon delimited paths to Gazebo install.

Parameters

[in]

_path

the directory to add

void AddModelPaths

(

const std::string &

_path

)

Add colon delimited paths to modelPaths.

Parameters

[in]

_path

the directory to add

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

void AddOgrePaths

(

const std::string &

_path

)

Add colon delimited paths to ogre install.

Parameters

[in]

_path

the directory to add

void AddPluginPaths

(

const std::string &

_path

)

Add colon delimited paths to plugins.

Parameters

[in]

_path

the directory to add

void AddSearchPathSuffix

(

const std::string &

_suffix

)

add _suffix to the list of path search suffixes

Parameters

[in]

_suffix

The suffix to add

void ClearGazeboPaths

(

)

clear out SystemPaths::gazeboPaths

void ClearModelPaths

(

)

clear out SystemPaths::modelPaths

void ClearOgrePaths

(

)

clear out SystemPaths::ogrePaths

void ClearPluginPaths

(

)

clear out SystemPaths::pluginPaths

std::string DefaultTestPath

(

)

const

Returns the default temporary test path.

Returns

a full path name to directory. E.g.: /tmp/gazebo_test (Linux).

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

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

const std::list<std::string>& GetGazeboPaths

(

)

Get the gazebo install paths.

Returns

a list of paths

std::string GetLogPath

(

)

const

Get the log path.

Returns

the path

const std::list<std::string>& GetModelPaths

(

)

Get the model paths.

Returns

a list of paths

const std::list<std::string>& GetOgrePaths

(

)

Get the ogre install paths.

Returns

a list of paths

const std::list<std::string>& GetPluginPaths

(

)

Get the plugin paths.

Returns

a list of paths

std::string GetWorldPathExtension

(

)

Returns the world path extension.

Returns

Right now, it just returns "/worlds"

static SystemPaths * Instance ( )

inlinestaticinherited

Get an instance of the singleton.

Referenced by PluginT< ModelPlugin >::Create().

const std::string& TmpInstancePath

(

)

const

Returns a unique temporary file for this instance of SystemPath.

Returns

a full path name to directory. E.g.: /tmp/gazebo_234123 (Linux).

const std::string& TmpPath

(

)

const

Returns the default path suitable for temporary files.

Returns

a full path name to directory. E.g.: /tmp (Linux).

Member Data Documentation

bool gazeboPathsFromEnv

if true, call UpdateGazeboPaths() within GetGazeboPaths()

bool modelPathsFromEnv

if true, call UpdateGazeboPaths() within GetGazeboPaths()

bool ogrePathsFromEnv

if true, call UpdateOgrePaths() within GetOgrePaths()

bool pluginPathsFromEnv

if true, call UpdatePluginPaths() within GetPluginPaths()

event::EventT<void (std::string)> updateModelRequest

Event to notify InsertModelWidget that the model paths were changed.

---

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

• SystemPaths.hh