Open 3D Engine ROS2 Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ROS2::Controllers::PidConfiguration Class Reference

#include <PidConfiguration.h>

Public Member Functions

 AZ_TYPE_INFO (PidConfiguration, "{814E0D1E-2C33-44A5-868E-C914640E2F7E}")
 
void InitializePid ()
 Initialize PID using member fields as set by the user.
 
double ComputeCommand (double error, uint64_t deltaTimeNanoseconds)
 

Static Public Member Functions

static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

A wrapper for ROS 2 control_toolbox pid controller.

See also
control_toolbox.

Member Function Documentation

◆ ComputeCommand()

double ROS2::Controllers::PidConfiguration::ComputeCommand ( double  error,
uint64_t  deltaTimeNanoseconds 
)

Compute the value of PID command.

Parameters
errorValue of difference between target and state since last call.
deltaTimeNanosecondschange in time since last call (nanoseconds).
Returns
Value of computed command.

The documentation for this class was generated from the following file: