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

Simulates an absolute or relative encoder mapping to mechanical state. More...

#include <encoder_sim.hpp>

Public Member Functions

 EncoderSim ()=default
virtual ~EncoderSim ()=default
virtual double GetPosition () const =0
 Returns the simulated raw position or tick count.
virtual double GetRate () const =0
 Returns the simulated velocity/rate.

Detailed Description

Simulates an absolute or relative encoder mapping to mechanical state.

Constructor & Destructor Documentation

◆ EncoderSim()

frcsim::EncoderSim::EncoderSim ( )
default

◆ ~EncoderSim()

virtual frcsim::EncoderSim::~EncoderSim ( )
virtualdefault

Member Function Documentation

◆ GetPosition()

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

Returns the simulated raw position or tick count.

Returns
Simulated position.

◆ GetRate()

virtual double frcsim::EncoderSim::GetRate ( ) const
pure virtual

Returns the simulated velocity/rate.

Returns
Simulated rate.

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