module documentation
Internal use: ROS Node (Slave) API.
The Node API is implemented by the L{ROSHandler}.
API return convention: (statusCode, statusMessage, returnValue)
- statusCode: an integer indicating the completion condition of the method.
- statusMessage: a human-readable string message for debugging
- returnValue: the return value of the method; method-specific.
Current status codes:
- -1: ERROR: Error on the part of the caller, e.g. an invalid parameter
- 0: FAILURE: Method was attempted but failed to complete correctly.
- 1: SUCCESS: Method completed successfully.
Individual methods may assign additional meaning/semantics to statusCode.
| Class | |
Base handler for both slave and master nodes. API methods generally provide the capability for establishing point-to-point connections with other nodes. |
| Function | apivalidate |
ROS master/slave arg-checking decorator. Applies the specified validator to the corresponding argument and also remaps each argument to be the value returned by the validator. Thus, arguments can be simultaneously validated and canonicalized prior to actual function call... |
| Function | is |
Undocumented |
| Constant | LOG |
Undocumented |
| Constant | MSG |
Undocumented |
| Constant | STATUS |
Undocumented |
| Constant | VAL |
Undocumented |
| Variable | _logger |
Undocumented |
ROS master/slave arg-checking decorator. Applies the specified validator to the corresponding argument and also remaps each argument to be the value returned by the validator. Thus, arguments can be simultaneously validated and canonicalized prior to actual function call. @param error_return_value: API value to return if call unexpectedly fails @param validators: sequence of validators to apply to each
arg. None means no validation for the parameter is required. As all api methods take caller_id as the first parameter, the validators start with the second param.
@type validators: sequence