Package node_manager_fkie :: Module settings' :: Class Settings

Class Settings

object --+
         |
        Settings

Instance Methods

__init__(self)
x.__init__(...) initializes x; see help(type(x)) for signature

source code

reload(self)
Loads the settings from file or sets default values if no one exists.

source code

masteruri(self)

source code

host_user(self, host)

source code

set_host_user(self, host, user)

source code

robot_image_file(self, robot_name)

source code

rosconsole_cfg_file(self, package)

source code

store_logging(self)

source code

host_color(self, host, default_color)

source code

set_host_color(self, host, color)

source code

launch_history_add(self, path, replace=None)
Adds a path to the list of recently loaded files.

source code

launch_history_remove(self, path)
Removes a path from the list of recently loaded files.

source code

str2bool(self, v)

source code

str2list(self, l)

source code

str

terminal_cmd(self, cmd, title, noclose=False)
Creates a command string to run with a terminal prefix

source code

qsettings(self, settings_file)

source code

init_hosts_color_list(self)

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables
	USER_DEFAULT = `'robot'`
	PKG_NAME = `'node_manager_fkie'`
	PACKAGE_DIR = `u'/tmp/ws/install_isolated/share/node_manager_fkie'`
	ROBOTS_DIR = `u'/tmp/ws/install_isolated/share/node_manager_fki...`
	HELP_FILE = `u'/tmp/ws/install_isolated/share/node_manager_fkie...`
	CURRENT_DIALOG_PATH = `'/home/buildfarm'`
	LOG_PATH = `'/home/buildfarm/.ros/log/'`
	LOG_VIEWER = `'/usr/bin/less -fKLnQrSU'`
	STARTER_SCRIPT = `'rosrun node_manager_fkie remote_nm.py'`
	RESPAWN_SCRIPT = `'rosrun node_manager_fkie respawn'` the script used on remote hosts to start new ROS nodes
	LAUNCH_HISTORY_FILE = `'launch.history'`
	LAUNCH_HISTORY_LENGTH = `5`
	PARAM_HISTORY_FILE = `'param.history'`
	PARAM_HISTORY_LENGTH = `12`
	CFG_REDIRECT_FILE = `'redirect'`
	CFG_FILE = `'settings.ini'`
	CFG_GUI_FILE = `'settings.ini'`
	TIMEOUT_CONTROL = `5`
	TIMEOUT_UPDATES = `20`
	SEARCH_IN_EXT = `['.launch', '.yaml', '.conf', '.cfg', '.iface'...`
	LAUNCH_VIEW_EXT = `['.yaml', '.conf', '.cfg', '.iface', '.nmpro...`
	STORE_GEOMETRY = `True`
	MOVABLE_DOCK_WIDGETS = `True`
	AUTOUPDATE = `True`
	MAX_TIMEDIFF = `0.5`
	START_SYNC_WITH_DISCOVERY = `False`
	CONFIRM_EXIT_WHEN_CLOSING = `True`
	HIGHLIGHT_XML_BLOCKS = `True`
	COLORIZE_HOSTS = `True`
	CHECK_FOR_NODELETS_AT_START = `True`
	SHOW_NOSCREEN_ERROR = `True`
	SHOW_DOMAIN_SUFFIX = `False`
	TRANSPOSE_PUB_SUB_DESCR = `True`
	TIMEOUT_CLOSE_DIALOG = `5.0`
	GROUP_BY_NAMESPACE = `True`
	DEAFULT_HOST_COLORS = `[4294967275]`

Instance Variables
	CFG_PATH = `'/'` configuration path to store the history.

Properties
	cfg_path
	robots_path
	default_user
	launch_history_length
	param_history_length
	current_dialog_path
	log_viewer
	start_remote_script
	respawn_script
	launch_view_file_ext
	store_geometry
	movable_dock_widgets
	autoupdate
	max_timediff
	start_sync_with_discovery
	confirm_exit_when_closing
	highlight_xml_blocks
	colorize_hosts
	check_for_nodelets_at_start
	show_noscreen_error
	show_domain_suffix
	transpose_pub_sub_descr
	timeout_close_dialog
	group_nodes_by_namespace
`[str]`	launch_history Read the history of the recently loaded files from the file stored in ROS_HOME path.
Inherited from `object`: `__class__`

Method Details

init(self)
(Constructor)

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

launch_history_add(self, path, replace=None)

source code

Adds a path to the list of recently loaded files. :param path: the path with the file name :type path: str :param replace: the path to replace, e.g. rename :type replace: str

launch_history_remove(self, path)

source code

Removes a path from the list of recently loaded files. :param path: the path with the file name :type path: str

terminal_cmd(self, cmd, title, noclose=False)

source code

Creates a command string to run with a terminal prefix

Parameters:

cmd ([str,..]) - the list with a command and args
title (str) - the title of the terminal

Returns: str

command with a terminal prefix

Class Variable Details

ROBOTS_DIR

Value:

u'/tmp/ws/install_isolated/share/node_manager_fkie/images'

HELP_FILE

Value:

u'/tmp/ws/install_isolated/share/node_manager_fkie/README.rst'

SEARCH_IN_EXT

Value:

['.launch',
 '.yaml',
 '.conf',
 '.cfg',
 '.iface',
 '.nmprofile',
 '.sync',
 '.test',
...

LAUNCH_VIEW_EXT

Value:

['.yaml', '.conf', '.cfg', '.iface', '.nmprofile', '.sync', '.test']

Property Details

cfg_path

Get Method:: unreachable.cfg_path(self)
Set Method:: unreachable.cfg_path(self, path)

robots_path

Get Method:: unreachable.robots_path(self)
Set Method:: unreachable.robots_path(self, path)

default_user

Get Method:: unreachable.default_user(self)
Set Method:: unreachable.default_user(self, user)

launch_history_length

Get Method:: unreachable.launch_history_length(self)
Set Method:: unreachable.launch_history_length(self, length)

param_history_length

Get Method:: unreachable.param_history_length(self)
Set Method:: unreachable.param_history_length(self, length)

current_dialog_path

Get Method:: unreachable.current_dialog_path(self)
Set Method:: unreachable.current_dialog_path(self, path)

log_viewer

Get Method:: unreachable.log_viewer(self)
Set Method:: unreachable.log_viewer(self, viewer)

start_remote_script

Get Method:: unreachable.start_remote_script(self)
Set Method:: unreachable.start_remote_script(self, script)

respawn_script

Get Method:: unreachable.respawn_script(self)
Set Method:: unreachable.respawn_script(self, script)

launch_view_file_ext

Get Method:: unreachable.launch_view_file_ext(self)
Set Method:: unreachable.launch_view_file_ext(self, exts)

store_geometry

Get Method:: unreachable.store_geometry(self)
Set Method:: unreachable.store_geometry(self, value)

movable_dock_widgets

Get Method:: unreachable.movable_dock_widgets(self)
Set Method:: unreachable.movable_dock_widgets(self, value)

autoupdate

Get Method:: unreachable.autoupdate(self)
Set Method:: unreachable.autoupdate(self, value)

max_timediff

Get Method:: unreachable.max_timediff(self)
Set Method:: unreachable.max_timediff(self, value)

start_sync_with_discovery

Get Method:: unreachable.start_sync_with_discovery(self)
Set Method:: unreachable.start_sync_with_discovery(self, value)

confirm_exit_when_closing

Get Method:: unreachable.confirm_exit_when_closing(self)
Set Method:: unreachable.confirm_exit_when_closing(self, value)

highlight_xml_blocks

Get Method:: unreachable.highlight_xml_blocks(self)
Set Method:: unreachable.highlight_xml_blocks(self, value)

colorize_hosts

Get Method:: unreachable.colorize_hosts(self)
Set Method:: unreachable.colorize_hosts(self, value)

check_for_nodelets_at_start

Get Method:: unreachable.check_for_nodelets_at_start(self)
Set Method:: unreachable.check_for_nodelets_at_start(self, value)

show_noscreen_error

Get Method:: unreachable.show_noscreen_error(self)
Set Method:: unreachable.show_noscreen_error(self, value)

show_domain_suffix

Get Method:: unreachable.show_domain_suffix(self)
Set Method:: unreachable.show_domain_suffix(self, value)

transpose_pub_sub_descr

Get Method:: unreachable.transpose_pub_sub_descr(self)
Set Method:: unreachable.transpose_pub_sub_descr(self, value)

timeout_close_dialog

Get Method:: unreachable.timeout_close_dialog(self)
Set Method:: unreachable.timeout_close_dialog(self, value)

group_nodes_by_namespace

Get Method:: unreachable.group_nodes_by_namespace(self)
Set Method:: unreachable.group_nodes_by_namespace(self, value)

launch_history

Read the history of the recently loaded files from the file stored in ROS_HOME path.

Get Method:: unreachable.launch_history(self) - Read the history of the recently loaded files from the file stored in ROS_HOME path.
Type:: [str]

Class Settings

__init__(self) (Constructor)

launch_history_add(self, path, replace=None)

launch_history_remove(self, path)

terminal_cmd(self, cmd, title, noclose=False)

ROBOTS_DIR

HELP_FILE

SEARCH_IN_EXT

LAUNCH_VIEW_EXT

cfg_path

robots_path

default_user

launch_history_length

param_history_length

current_dialog_path

log_viewer

start_remote_script

respawn_script

launch_view_file_ext

store_geometry

movable_dock_widgets

autoupdate

max_timediff

start_sync_with_discovery

confirm_exit_when_closing

highlight_xml_blocks

colorize_hosts

check_for_nodelets_at_start

show_noscreen_error

show_domain_suffix

transpose_pub_sub_descr

timeout_close_dialog

group_nodes_by_namespace

launch_history

init(self)
(Constructor)