Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-28 02:11:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Document how to create LinearSystem object for physics sim classes (NFC) (#5488)

Browse Source 
Fixes #4372.
This commit is contained in:
Tyler Veness
2023-07-31 19:18:17 -07:00
committed by GitHub
parent a01b6467d3
commit 6aa469ae45
10 changed files with 38 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
wpilibc/src/main/native/include/frc/simulation/SingleJointedArmSim.h
View File

@@ -23,7 +23,9 @@ class SingleJointedArmSim : public LinearSystemSim<2, 1, 1> {
/**
* Creates a simulated arm mechanism.
*
* @param system The system representing this arm.
* @param system The system representing this arm. This system can
* be created with
* LinearSystemId::SingleJointedArmSystem().
* @param gearbox The type and number of motors on the arm gearbox.
* @param gearing The gear ratio of the arm (numbers greater than 1
* represent reductions).