Module actionlib.action_spec
action specification. This module contains the ActionSpec class to read and represent ROS action specification (YAML files). Action specifications should be obtained by using the get_actionspec()
function, which is aliased for convenience as actionlib.get_actionspec()
.
The service files are read on the fly, no offline code generation is necessary. This avoids the need to write yet another code generator. After reading the service specifications contains three fields, the ...
Copyright© Tim Niemueller, Carnegie Mellon University, Intel Research Pittsburgh
Release: Released under BSD license
Functions
ActionSpec:load () | Load service specification from file. |
ActionSpec:load_from_string (s) | Load specification from string. |
ActionSpec:new (o) | Constructor. |
ActionSpec:print (indent) | Print specification. |
get_actionspec (action_type) | Get service specification. |
Functions
- ActionSpec:load ()
- Load service specification from file. Will search for the appropriate service specification file (using rospack) and will then read and parse the file.
- ActionSpec:load_from_string (s)
-
Load specification from string.
Parameters
- s: string containing the service specification
- ActionSpec:new (o)
-
Constructor.
Parameters
- o: Object initializer, must contain a field type with the string representation of the type name.
- ActionSpec:print (indent)
-
Print specification.
Parameters
- indent: string (normally spaces) to put before every line of output
- get_actionspec (action_type)
-
Get service specification. It is recommended to use the aliased version
roslua.get_actionspec()
.Parameters
- action_type: service type (e.g. std_msgs/String). The name must include the package.