Package node_manager_fkie
[frames] | no frames]

Package node_manager_fkie

source code


Version: unknown

Date: unknown

Author: Alexander Tiderko (Alexander.Tiderko@fkie.fraunhofer.de)

Copyright: Copyright (c) 2012 Alexander Tiderko, Fraunhofer FKIE/US

License: BSD

Submodules

Functions
Settings
settings()
Returns: The global settings
source code
SSHhandler
ssh()
Returns: The SSH handler to handle the SSH connections
source code
ScreenHandler
screen()
Returns: The screen handler to the screens.
source code
StartHandler
starter()
Returns: The start handler to handle the start of new ROS nodes on local or remote machines.
source code
NameResolution
nameres()
Returns: The name resolution object translate the the name to the host or ROS master URI.
source code
History
history()
Returns: The history of entered parameter.
source code
FileWatcher
filewatcher()
Returns: The file watcher object with all loaded configuration files.
source code
FileWatcher
file_watcher_param()
Returns: The file watcher object with all configuration files referenced by parameter value.
source code
str
get_ros_hostname(url)
Returns the host name used in a url, if it is a name.
source code
bool
is_local(hostname, wait=False)
Test whether the given host name is the name of the local host or not.
source code
 
detect_version()
Try to detect the current version from git, installed VERSION/DATE files or package.xml
source code
 
finish(*arg)
Callback called on exit of the ros node.
source code
 
set_terminal_name(name)
Change the terminal name.
source code
 
set_process_name(name)
Change the process name.
source code
 
init_settings() source code
 
init_globals(masteruri)
:return: True if the masteruri referred to localhost :rtype: bool
source code
 
init_arg_parser() source code
 
init_echo_dialog(prog_name, masteruri, topic_name, topic_type, hz=False, use_ssh=False)
Intialize the environment to start an echo window.
source code
 
init_main_window(prog_name, masteruri, launch_files=[])
Intialize the environment to start Node Manager.
source code
 
main(name)
Start the NodeManager or EchoDialog.
source code
Variables
  PKG_NAME = 'node_manager_fkie'
  HOSTS_CACHE = dict()
the cache directory to store the results of tests for local hosts.
Function Details

settings()

source code 
Returns: Settings
The global settings

ssh()

source code 
Returns: SSHhandler
The SSH handler to handle the SSH connections

screen()

source code 
Returns: ScreenHandler
The screen handler to the screens.

starter()

source code 
Returns: StartHandler
The start handler to handle the start of new ROS nodes on local or remote machines.

nameres()

source code 
Returns: NameResolution
The name resolution object translate the the name to the host or ROS master URI.

history()

source code 
Returns: History
The history of entered parameter.

filewatcher()

source code 
Returns: FileWatcher
The file watcher object with all loaded configuration files.

file_watcher_param()

source code 
Returns: FileWatcher
The file watcher object with all configuration files referenced by parameter value.

get_ros_hostname(url)

source code 

Returns the host name used in a url, if it is a name. If it is an IP an empty string will be returned.

Returns: str
host or '' if url is an IP or invalid

is_local(hostname, wait=False)

source code 

Test whether the given host name is the name of the local host or not.

Parameters:
  • hostname (str) - the name or IP of the host
Returns: bool
True if the hostname is local or None
Raises:
  • Exception - on errors while resolving host

set_terminal_name(name)

source code 

Change the terminal name.

Parameters:
  • name (str) - New name of the terminal

set_process_name(name)

source code 

Change the process name.

Parameters:
  • name (str) - New process name

main(name)

source code 

Start the NodeManager or EchoDialog. :param name: the name propagated to the rospy.init_node() :type name: str


Variables Details

HOSTS_CACHE

the cache directory to store the results of tests for local hosts.

See Also: is_local()

Value:
dict()