frc::sysid::SysIdRoutineLog::MotorLog Class Reference

Logs data from a single motor during a SysIdRoutine. More...

#include <frc/sysid/SysIdRoutineLog.h>

Public Member Functions
MotorLog &	value (std::string_view name, double value, std::string_view unit)
	Log a generic data value from the motor. More...
MotorLog &	voltage (units::volt_t voltage)
	Log the voltage applied to the motor. More...
MotorLog &	position (units::meter_t position)
	Log the linear position of the motor. More...
MotorLog &	position (units::turn_t position)
	Log the angular position of the motor. More...
MotorLog &	velocity (units::meters_per_second_t velocity)
	Log the linear velocity of the motor. More...
MotorLog &	velocity (units::turns_per_second_t velocity)
	Log the angular velocity of the motor. More...
MotorLog &	acceleration (units::meters_per_second_squared_t acceleration)
	Log the linear acceleration of the motor. More...
MotorLog &	acceleration (units::turns_per_second_squared_t acceleration)
	Log the angular acceleration of the motor. More...
MotorLog &	current (units::ampere_t current)
	Log the current applied to the motor. More...

Friends
class	SysIdRoutineLog

Detailed Description

Logs data from a single motor during a SysIdRoutine.

Member Function Documentation

acceleration() [1/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::acceleration ( units::meters_per_second_squared_t  acceleration )

inline

Log the linear acceleration of the motor.

This is optional; SysId can perform an accurate fit without it.

Parameters

acceleration

The linear acceleration to record.

Returns

The motor log (for call chaining).

acceleration() [2/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::acceleration ( units::turns_per_second_squared_t  acceleration )

inline

Log the angular acceleration of the motor.

This is optional; SysId can perform an accurate fit without it.

Parameters

acceleration

The angular acceleration to record.

Returns

The motor log (for call chaining).

current()

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::current ( units::ampere_t  current )

inline

Log the current applied to the motor.

This is optional; SysId can perform an accurate fit without it.

Parameters

current

The current to record.

Returns

The motor log (for call chaining).

position() [1/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::position ( units::meter_t  position )

inline

Log the linear position of the motor.

Parameters

position

The linear position to record.

Returns

The motor log (for call chaining).

position() [2/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::position ( units::turn_t  position )

inline

Log the angular position of the motor.

Parameters

position

The angular position to record.

Returns

The motor log (for call chaining).

value()

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::value	(	std::string_view	name,
		double	value,
		std::string_view	unit
	)

Log a generic data value from the motor.

Parameters

name	The name of the data field being recorded.
value	The numeric value of the data field.
unit	The unit string of the data field.

Returns

The motor log (for call chaining).

velocity() [1/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::velocity ( units::meters_per_second_t  velocity )

inline

Log the linear velocity of the motor.

Parameters

velocity

The linear velocity to record.

Returns

The motor log (for call chaining).

velocity() [2/2]

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::velocity ( units::turns_per_second_t  velocity )

inline

Log the angular velocity of the motor.

Parameters

velocity

The angular velocity to record.

Returns

The motor log (for call chaining).

voltage()

MotorLog & frc::sysid::SysIdRoutineLog::MotorLog::voltage ( units::volt_t  voltage )

inline

Log the voltage applied to the motor.

Parameters

voltage

The voltage to record.

Returns

The motor log (for call chaining).

Friends And Related Function Documentation

SysIdRoutineLog

friend class SysIdRoutineLog

friend

---

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

• frc/sysid/SysIdRoutineLog.h