Package node_manager_fkie :: Module settings' :: Class Settings
[frames] | no frames]

Class Settings

source code

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
 
cfg_path(self, path) source code
 
robots_path(self, path) source code
 
default_user(self, user) source code
 
host_user(self, host) source code
 
set_host_user(self, host, user) source code
 
launch_history_length(self, length) source code
 
param_history_length(self, length) source code
 
current_dialog_path(self, path) source code
 
robot_image_file(self, robot_name) source code
 
log_viewer(self, viewer) source code
 
start_remote_script(self, script) source code
 
respawn_script(self, script) source code
 
launch_view_file_ext(self, exts) source code
 
store_geometry(self, value) source code
 
movable_dock_widgets(self, value) source code
 
autoupdate(self, value) source code
 
max_timediff(self, value) source code
 
rosconsole_cfg_file(self, package) source code
 
store_logging(self) source code
 
start_sync_with_discovery(self, value) source code
 
confirm_exit_when_closing(self, value) source code
 
highlight_xml_blocks(self, value) source code
 
colorize_hosts(self, value) source code
 
check_for_nodelets_at_start(self, value) source code
 
show_noscreen_error(self, value) source code
 
show_domain_suffix(self, value) source code
 
transpose_pub_sub_descr(self, value) source code
 
timeout_close_dialog(self, value) source code
 
group_nodes_by_namespace(self, value) source code
 
host_color(self, host, default_color) source code
 
set_host_color(self, host, color) source code
[str]
launch_history(self)
Read the history of the recently loaded files from the file stored in ROS_HOME path.
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 = "%s/../../share/node_manager_fkie" % PACKAGE_DIR
  ROBOTS_DIR = os.path.join(PACKAGE_DIR, 'images')
  HELP_FILE = os.path.join(PACKAGE_DIR, 'README.rst')
  CURRENT_DIALOG_PATH = os.path.expanduser('~')
  LOG_PATH = os.environ.get('ROS_LOG_DIR') if os.environ.get('RO...
  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 = [QColor(255, 255, 235).rgb()]
Instance Variables
  CFG_PATH = os.path.join('.node_manager', os.sep)
configuration path to store the history.
Properties

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)

cfg_path(self, path)

source code 
Decorators:
  • @cfg_path.setter

robots_path(self, path)

source code 
Decorators:
  • @robots_path.setter

default_user(self, user)

source code 
Decorators:
  • @default_user.setter

launch_history_length(self, length)

source code 
Decorators:
  • @launch_history_length.setter

param_history_length(self, length)

source code 
Decorators:
  • @param_history_length.setter

current_dialog_path(self, path)

source code 
Decorators:
  • @current_dialog_path.setter

log_viewer(self, viewer)

source code 
Decorators:
  • @log_viewer.setter

start_remote_script(self, script)

source code 
Decorators:
  • @start_remote_script.setter

respawn_script(self, script)

source code 
Decorators:
  • @respawn_script.setter

launch_view_file_ext(self, exts)

source code 
Decorators:
  • @launch_view_file_ext.setter

store_geometry(self, value)

source code 
Decorators:
  • @store_geometry.setter

movable_dock_widgets(self, value)

source code 
Decorators:
  • @movable_dock_widgets.setter

autoupdate(self, value)

source code 
Decorators:
  • @autoupdate.setter

max_timediff(self, value)

source code 
Decorators:
  • @max_timediff.setter

start_sync_with_discovery(self, value)

source code 
Decorators:
  • @start_sync_with_discovery.setter

confirm_exit_when_closing(self, value)

source code 
Decorators:
  • @confirm_exit_when_closing.setter

highlight_xml_blocks(self, value)

source code 
Decorators:
  • @highlight_xml_blocks.setter

colorize_hosts(self, value)

source code 
Decorators:
  • @colorize_hosts.setter

check_for_nodelets_at_start(self, value)

source code 
Decorators:
  • @check_for_nodelets_at_start.setter

show_noscreen_error(self, value)

source code 
Decorators:
  • @show_noscreen_error.setter

show_domain_suffix(self, value)

source code 
Decorators:
  • @show_domain_suffix.setter

transpose_pub_sub_descr(self, value)

source code 
Decorators:
  • @transpose_pub_sub_descr.setter

timeout_close_dialog(self, value)

source code 
Decorators:
  • @timeout_close_dialog.setter

group_nodes_by_namespace(self, value)

source code 
Decorators:
  • @group_nodes_by_namespace.setter

launch_history(self)

source code 

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

Returns: [str]
the list with file names
Decorators:
  • @property

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

LOG_PATH

Value:
os.environ.get('ROS_LOG_DIR') if os.environ.get('ROS_LOG_DIR') else os\
.path.join(os.path.expanduser('~'), '.ros/log/')

SEARCH_IN_EXT

Value:
['.launch', '.yaml', '.conf', '.cfg', '.iface', '.nmprofile', '.sync',\
 '.test', '.xml']

LAUNCH_VIEW_EXT

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