rosman Namespace Reference

Classes
class	DocTopicReader

Functions
def	_check_master (rosmaster)
def	_rosman_check_main (argv)
def	_rosman_node_main (argv)
def	_rosman_param_main (argv)
def	_rosman_service_main (argv)
def	_rosman_topic_main (argv)
def	_sort_fn (e)
def	_tool_usage (return_error=True)
def	compare_param (rosmaster, node_name, yaml=False, output_file=sys.stdout, reverse=False)
def	get_documentation_publications (rosmaster, ros_sys_state=None)
def	read_documentation_topic (rosmaster, topic, yaml=False, output_file=sys.stdout)
def	rosman_node (rosmaster, node_name, yaml=False, output_file=sys.stdout)
def	rosman_node_fallback (rosmaster, node_name, yaml=False, output_file=sys.stdout)
def	rosman_param (rosmaster, param)
def	rosman_service (rosmaster, service)
def	rosman_topic (rosmaster, topic)
def	rosmanmain (argv=None)

Variables
	DOCUMENTATION_TOPIC_MATCHER = re.compile("/documentation$")

Function Documentation

_check_master()

def rosman._check_master (   rosmaster )

private

Definition at line 24 of file __init__.py.

_rosman_check_main()

def rosman._rosman_check_main (   argv )

private

Entry point for rosman check command

Definition at line 486 of file __init__.py.

_rosman_node_main()

def rosman._rosman_node_main (   argv )

private

Entry point for rosman node command

Definition at line 459 of file __init__.py.

_rosman_param_main()

def rosman._rosman_param_main (   argv )

private

Entry point for rosman params command

Definition at line 613 of file __init__.py.

_rosman_service_main()

def rosman._rosman_service_main (   argv )

private

Entry point for rosman services command

Definition at line 627 of file __init__.py.

_rosman_topic_main()

def rosman._rosman_topic_main (   argv )

private

Entry point for rosman topics command

Definition at line 599 of file __init__.py.

_sort_fn()

def rosman._sort_fn (   e )

private

Definition at line 31 of file __init__.py.

_tool_usage()

def rosman._tool_usage (   return_error = True )

private

Print the full usage information for the rosman tool.
@param return_error set to true to return from this printout with error code os.EX_USAGE, otherwise exit returning 0.

Definition at line 641 of file __init__.py.

compare_param()

def rosman.compare_param	(		rosmaster,
			node_name,
			yaml = False,
			output_file = sys.stdout,
			reverse = False
	)

Definition at line 508 of file __init__.py.

get_documentation_publications()

def rosman.get_documentation_publications	(		rosmaster,
			ros_sys_state = None
	)

Get all the current documentation topics in the system

Definition at line 246 of file __init__.py.

read_documentation_topic()

def rosman.read_documentation_topic	(		rosmaster,
			topic,
			yaml = False,
			output_file = sys.stdout
	)

Definition at line 238 of file __init__.py.

rosman_node()

def rosman.rosman_node	(		rosmaster,
			node_name,
			yaml = False,
			output_file = sys.stdout
	)

Definition at line 272 of file __init__.py.

rosman_node_fallback()

def rosman.rosman_node_fallback	(		rosmaster,
			node_name,
			yaml = False,
			output_file = sys.stdout
	)

Definition at line 283 of file __init__.py.

rosman_param()

def rosman.rosman_param	(		rosmaster,
			param
	)

Definition at line 422 of file __init__.py.

rosman_service()

def rosman.rosman_service	(		rosmaster,
			service
	)

Definition at line 436 of file __init__.py.

rosman_topic()

def rosman.rosman_topic	(		rosmaster,
			topic
	)

Definition at line 377 of file __init__.py.

rosmanmain()

def rosman.rosmanmain

(

argv = None

)

Prints rosman main entrypoint.
@param argv: override sys.argv
@param argv: [str]

Definition at line 661 of file __init__.py.

Variable Documentation

DOCUMENTATION_TOPIC_MATCHER

rosman.DOCUMENTATION_TOPIC_MATCHER = re.compile("/documentation$")

Definition at line 22 of file __init__.py.