Home       Trees       Indices       Help   
Module rosmsg
[frames] | no frames]

Module rosmsg

source code

Implements rosmsg/rossrv command-line tools.

The code API of the rosmsg module is unstable. Much of the functionality of rosmsg/rossrv is implemented using the roslib.msgs and roslib.srvs libraries and can be found there instead.

Classes
  ROSMsgException
Functions
 
deprecated(func)
This is a decorator which can be used to mark functions as deprecated.		 source code
 
succeed(args) source code
 
make_find_command(path) source code
 
rosmsg_users_package_search(mode, type_, package) source code
 
rosmsg_users(mode, type_) source code
str
get_srv_text(type_, raw=False)
Get .srv file for type_ as text		 source code
str
get_msg_text(type_, raw=False, full_text=None)
Get .msg file for type_ as text		 source code
 
rosmsg_debug(mode, type_, raw=False)
Prints contents of msg/srv file		 source code
[str]
list_srvs(package)
List srvs contained in package		 source code
[str]
list_msgs(package)
List msgs contained in package		 source code
 
rosmsg_list_package(*args, **kwargs) source code
[str]
list_types(package, mode='.msg')
Lists msg/srvs contained in package		 source code
 
iterate_packages(mode)
Iterator for packages that contain messages/services		 source code
 
rosmsg_list_packages(*args, **kwargs)
Use list_packages		 source code
[str]
list_packages(mode='.msg')
List all packages that contain messages/services.		 source code
 
rosmsg_search(mode, base_type) source code
 
rosmsg_cmd_show(mode, full) source code
 
rosmsg_md5(mode, type_) source code
 
rosmsg_cmd_md5(mode, full) source code
 
rosmsg_cmd_users(mode, full) source code
 
rosmsg_cmd_package(mode, full) source code
 
rosmsg_cmd_packages(mode, full) source code
str
fullusage(cmd)
Returns: usage text for cmd		 source code
 
rosmsgmain(mode='.msg')
Main entry point for command-line tools (rosmsg/rossrv).		 source code
Variables
  __package__ = None
Function Details

deprecated(func)

source code 

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emmitted when the function is used.

get_srv_text(type_, raw=False)

source code 

Get .srv file for type_ as text

Parameters:
  • type_ (str) - service type
  • raw (bool) - if True, include comments and whitespace (default False)
Returns: str
text of .srv file
Raises:

get_msg_text(type_, raw=False, full_text=None)

source code 

Get .msg file for type_ as text

Parameters:
  • type_ (str) - message type
  • raw (bool) - if True, include comments and whitespace (default False)
  • full_text (str) - if not None, contains full text of message definition
Returns: str
text of .msg file
Raises:

rosmsg_debug(mode, type_, raw=False)

source code 

Prints contents of msg/srv file

Parameters:
  • mode (str) - roslib.srvs.EXT or roslib.msgs.EXT

list_srvs(package)

source code 

List srvs contained in package

Parameters:
  • package (str) - package name
Returns: [str]
list of srvs in package

list_msgs(package)

source code 

List msgs contained in package

Parameters:
  • package (str) - package name
Returns: [str]
list of msgs in package

rosmsg_list_package(*args, **kwargs)

source code 
Decorators:
  • @deprecated

list_types(package, mode='.msg')

source code 

Lists msg/srvs contained in package

Parameters:
  • package (str) - package name
  • mode (str) - roslib.srvs.EXT or roslib.msgs.EXT. Defaults to msgs.
Returns: [str]
list of msgs/srv in package

iterate_packages(mode)

source code 

Iterator for packages that contain messages/services

Parameters:
  • mode (str) - roslib.msgs.EXT or roslib.srvs.EXT

rosmsg_list_packages(*args, **kwargs)

source code 

Use list_packages

Decorators:
  • @deprecated

list_packages(mode='.msg')

source code 

List all packages that contain messages/services. This is a convenience function of iterate_packages

Parameters:
  • mode (str) - roslib.msgs.EXT or roslib.srvs.EXT. Defaults to msgs
Returns: [str]
list of packages that contain messages/services (depending on mode)

fullusage(cmd)

source code 
Parameters:
  • cmd (str) - command name
Returns: str
usage text for cmd

rosmsgmain(mode='.msg')

source code 

Main entry point for command-line tools (rosmsg/rossrv).

rosmsg can interact with either ros messages or ros services. The mode param indicates which

Parameters:
  • mode (str) - roslib.msgs.EXT or roslib.srvs.EXT

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Fri Jan 11 10:11:55 2013 http://epydoc.sourceforge.net