rclpy.validate_parameter_name module

rclpy.validate_parameter_name.validate_parameter_name(name: str) → bool

Validate a given parameter name, and raise an exception if invalid.

The name does not have to be fully-qualified and is not expanded.

If the name is invalid then rclpy.exceptions.InvalidParameterException will be raised.

Parameters:

str (name) – parameter name to be validated.

Raises:

InvalidParameterException: when the name is invalid.