rospy.impl.masterslave

Module masterslave

Internal use: ROS Node (Slave) API.

The Node API is implemented by the 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.

Classes

ROSHandler
Base handler for both slave and master nodes.

Functions

is_publishers_list(paramName)

source code

apivalidate(error_return_value, validators=())
ROS master/slave arg-checking decorator. source code

Variables

STATUS = 0

MSG = 1

VAL = 2

LOG_API = True

__package__ = 'rospy.impl'

Function Details

apivalidate(error_return_value, validators=`()`)

source code

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.

Parameters:

error_return_value - API value to return if call unexpectedly fails
validators (sequence) - 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.

Module masterslave

apivalidate(error_return_value, validators=())

apivalidate(error_return_value, validators=`()`)