stp.local_parameters
¶
Usage: in the global scope of a module, at initialization time, construct a Param.
`python
from stp.local_parameters import Param
my_parameter = Param("my_param_name", 1.0, Param.PARAMETER_DOUBLE)
`
Call register_parameters in gameplay init. Then, use the parameters:
`
do_something(my_parameter.value)
`
Module Contents¶
Classes¶
Functions¶
|
Update a set of parameters with new values. |
|
Register all parameters. This should be called after module initialization. |
|
Attributes¶
- stp.local_parameters.parameters¶
- stp.local_parameters.param_node :Optional[rclpy.node.Node]¶
- class stp.local_parameters.Param(name: str, default_value, param_type: rcl_interfaces.msg.ParameterType = None, description: str = '')¶
- property value¶
- PARAMETER_NOT_SET¶
- PARAMETER_BOOL¶
- PARAMETER_INTEGER¶
- PARAMETER_DOUBLE¶
- PARAMETER_BYTE_ARRAY¶
- PARAMETER_BOOL_ARRAY¶
- PARAMETER_INTEGER_ARRAY¶
- PARAMETER_DOUBLE_ARRAY¶
- stp.local_parameters.update_params(params: List[rclpy.parameter.Parameter]) rcl_interfaces.msg.SetParametersResult ¶
Update a set of parameters with new values. :param params: A list of ROS Parameter changes
- stp.local_parameters.register_parameters(node: rclpy.node.Node)¶
Register all parameters. This should be called after module initialization.
- Parameters:
node – The gameplay node
- stp.local_parameters.register_parameter(node: rclpy.node.Node, param_name: str, value, param_type: rcl_interfaces.msg.ParameterType, description: Optional[str])¶