REVLib - C++
Loading...
Searching...
No Matches
rev::spark::SparkFlexExternalEncoder Class Reference

#include <SparkFlexExternalEncoder.h>

Inherits rev::RelativeEncoder.

Public Member Functions

 SparkFlexExternalEncoder (SparkFlexExternalEncoder &&rhs)=default
 
SparkFlexExternalEncoder & operator= (SparkFlexExternalEncoder &&rhs)=default
 
 SparkFlexExternalEncoder (const SparkFlexExternalEncoder &rhs)=default
 
 ~SparkFlexExternalEncoder () override=default
 
rev::util::Signal< double > GetPosition () const override
 
rev::util::Signal< double > GetVelocity () const override
 
REVLibError SetPosition (double position) override
 
- Public Member Functions inherited from rev::RelativeEncoder
virtual ~RelativeEncoder ()=default
 

Friends

class SparkFlex
 

Constructor & Destructor Documentation

◆ SparkFlexExternalEncoder() [1/2]

rev::spark::SparkFlexExternalEncoder::SparkFlexExternalEncoder ( SparkFlexExternalEncoder && rhs)
default

◆ SparkFlexExternalEncoder() [2/2]

rev::spark::SparkFlexExternalEncoder::SparkFlexExternalEncoder ( const SparkFlexExternalEncoder & rhs)
default

◆ ~SparkFlexExternalEncoder()

rev::spark::SparkFlexExternalEncoder::~SparkFlexExternalEncoder ( )
overridedefault

Member Function Documentation

◆ operator=()

SparkFlexExternalEncoder & rev::spark::SparkFlexExternalEncoder::operator= ( SparkFlexExternalEncoder && rhs)
default

◆ GetPosition()

Signal< double > SparkFlexExternalEncoder::GetPosition ( ) const
overridevirtual

Get the position of the motor. This returns the native units of 'rotations'.

Returns
Signal containing the number of rotations of the motor

Implements rev::RelativeEncoder.

◆ GetVelocity()

Signal< double > SparkFlexExternalEncoder::GetVelocity ( ) const
overridevirtual

Get the velocity of the motor. This returns the native units of 'RPM'.

Returns
Signal containing the RPM of the motor

Implements rev::RelativeEncoder.

◆ SetPosition()

rev::REVLibError SparkFlexExternalEncoder::SetPosition ( double position)
overridevirtual

Set the position of the encoder.

Parameters
positionNumber of rotations of the motor
Returns
REVLibError::kOk if successful

Implements rev::RelativeEncoder.

Friends And Related Symbol Documentation

◆ SparkFlex

friend class SparkFlex
friend

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