niryo_libraries.roslib.rosenv

module documentation

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 ROSEnvException Base class of roslib.rosenv errors.
Function get_log_dir Get directory to use for writing log files. There are multiple possible locations for this. The ROS_LOG_DIR environment variable has priority. If that is not set, then ROS_HOME/log is used. If ROS_HOME is not set, $HOME/...
Function get_master_uri Get the ROS_MASTER_URI setting from the command-line args or environment, command-line args takes precedence. @param required: if True, enables exception raising @type required: bool @param env: override environment dictionary @type env: dict @param argv: override sys...
Function get_ros_home Get directory location of '.ros' directory (aka ROS home). possible locations for this. The ROS_LOG_DIR environment variable has priority. If that is not set, then ROS_HOME/log is used. If ROS_HOME is not set, $HOME/...
Function get_ros_package_path @param required: (default False) if True, ROS_PACKAGE_PATH must be set and point to a valid directory. @type required: bool @raise ROSEnvException: if ROS_PACKAGE_PATH is not set and \x07 required is True...
Function get_ros_root @param required: (default True). If True, ROS_ROOT must be set and point to a valid directory. @type required: bool @param env: override environment dictionary @type env: dict @raise ROSEnvException: if required is True and ROS_ROOT is not set...
Function get_test_results_dir Get directory to use for writing test result files. There are multiple possible locations for this. If ROS_HOME is set ROS_HOME/test_results is used. Otherwise $HOME/.ros/test_results is used.
Function makedirs_with_parent_perms Create the directory using the permissions of the nearest (existing) parent directory. This is useful for logging, where a root process sometimes has to log in the user's space. @param p: directory to create @type p: str...
Constant ROS_BINDEPS_PATH Undocumented
Constant ROS_BOOST_ROOT Undocumented
Constant ROS_HOME Undocumented
Constant ROS_HOSTNAME Undocumented
Constant ROS_IP Undocumented
Constant ROS_LOG_DIR Undocumented
Constant ROS_MASTER_URI Undocumented
Constant ROS_NAMESPACE Undocumented
Constant ROS_PACKAGE_PATH Undocumented
Constant ROS_ROOT Undocumented
def get_log_dir(env=None):

Get directory to use for writing log files. There are multiple possible locations for this. The ROS_LOG_DIR environment variable has priority. If that is not set, then ROS_HOME/log is used. If ROS_HOME is not set, $HOME/.ros/log is used.

@param env: override os.environ dictionary @type env: dict @return: path to use use for log file directory @rtype: str

def get_master_uri(required=True, env=None, argv=None):

Get the ROS_MASTER_URI setting from the command-line args or environment, command-line args takes precedence. @param required: if True, enables exception raising @type required: bool @param env: override environment dictionary @type env: dict @param argv: override sys.argv @type argv: [str] @raise ROSEnvException: if ROS_MASTER_URI value is invalidly specified or if required and ROS_MASTER_URI is not set

def get_ros_home(env=None):

Get directory location of '.ros' directory (aka ROS home). possible locations for this. The ROS_LOG_DIR environment variable has priority. If that is not set, then ROS_HOME/log is used. If ROS_HOME is not set, $HOME/.ros/log is used.

@param env: override os.environ dictionary @type env: dict @return: path to use use for log file directory @rtype: str

def get_ros_package_path(required=False, env=None):

@param required: (default False) if True, ROS_PACKAGE_PATH must be set and point to a valid directory. @type required: bool @raise ROSEnvException: if ROS_PACKAGE_PATH is not set and \x07 required is True

def get_ros_root(required=True, env=None):

@param required: (default True). If True, ROS_ROOT must be set and point to a valid directory. @type required: bool @param env: override environment dictionary @type env: dict @raise ROSEnvException: if required is True and ROS_ROOT is not set

def get_test_results_dir(env=None):

Get directory to use for writing test result files. There are multiple possible locations for this. If ROS_HOME is set ROS_HOME/test_results is used. Otherwise $HOME/.ros/test_results is used.

@param env: environment dictionary (defaults to os.environ) @type env: dict @return: path to use use for log file directory @rtype: str

def makedirs_with_parent_perms(p):

Create the directory using the permissions of the nearest (existing) parent directory. This is useful for logging, where a root process sometimes has to log in the user's space. @param p: directory to create @type p: str

ROS_BINDEPS_PATH: str =

Undocumented

Value
'ROS_BINDEPS_PATH'
ROS_BOOST_ROOT: str =

Undocumented

Value
'ROS_BOOST_ROOT'
ROS_HOME: str =

Undocumented

Value
'ROS_HOME'
ROS_HOSTNAME: str =

Undocumented

Value
'ROS_HOSTNAME'
ROS_IP: str =

Undocumented

Value
'ROS_IP'
ROS_LOG_DIR: str =

Undocumented

Value
'ROS_LOG_DIR'
ROS_MASTER_URI: str =

Undocumented

Value
'ROS_MASTER_URI'
ROS_NAMESPACE: str =

Undocumented

Value
'ROS_NAMESPACE'
ROS_PACKAGE_PATH: str =

Undocumented

Value
'ROS_PACKAGE_PATH'
ROS_ROOT: str =

Undocumented

Value
'ROS_ROOT'