JSim 2026.06.01-p(1)
Loading...
Searching...
No Matches
frcsim::Elevator Class Referenceabstract

Simulates a linear elevator mechanism. More...

#include <elevator.hpp>

Public Member Functions

 Elevator ()=default
virtual ~Elevator ()=default
virtual void Update (double voltage, double dt)=0
 Updates the elevator state based on applied voltage and physics.
virtual double GetPosition () const =0
 Gets the current position of the elevator.
virtual double GetVelocity () const =0
 Gets the current velocity of the elevator.

Detailed Description

Simulates a linear elevator mechanism.

Constructor & Destructor Documentation

◆ Elevator()

frcsim::Elevator::Elevator ( )
default

◆ ~Elevator()

virtual frcsim::Elevator::~Elevator ( )
virtualdefault

Member Function Documentation

◆ GetPosition()

virtual double frcsim::Elevator::GetPosition ( ) const
pure virtual

Gets the current position of the elevator.

Returns
The position in meters.

◆ GetVelocity()

virtual double frcsim::Elevator::GetVelocity ( ) const
pure virtual

Gets the current velocity of the elevator.

Returns
The velocity in meters per second.

◆ Update()

virtual void frcsim::Elevator::Update ( double voltage,
double dt )
pure virtual

Updates the elevator state based on applied voltage and physics.

Parameters
voltageThe input voltage.
dtThe timestep in seconds.

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