rev::SparkRelativeEncoder Class Reference

#include <SparkRelativeEncoder.h>

Inherits rev::SparkMaxRelativeEncoder.

Public Types
enum class	Type { kNoSensor = 0 , kHallSensor = 1 , kQuadrature = 2 }
Public Types inherited from rev::SparkMaxRelativeEncoder
enum class	Type { kNoSensor = 0 , kHallSensor = 1 , kQuadrature = 2 }
Public Types inherited from rev::CANEncoder
enum class	EncoderType { kNoSensor = 0 , kHallSensor = 1 , kQuadrature = 2 }
enum class	AlternateEncoderType { kQuadrature }

Public Member Functions
	SparkRelativeEncoder (SparkRelativeEncoder &&rhs)=default
SparkRelativeEncoder &	operator= (SparkRelativeEncoder &&rhs)=default
	SparkRelativeEncoder (const SparkRelativeEncoder &rhs)=default
	~SparkRelativeEncoder () override=default
Public Member Functions inherited from rev::SparkMaxRelativeEncoder
	SparkMaxRelativeEncoder (SparkMaxRelativeEncoder &&rhs)=default
SparkMaxRelativeEncoder &	operator= (SparkMaxRelativeEncoder &&rhs)=default
	SparkMaxRelativeEncoder (const SparkMaxRelativeEncoder &rhs)=default
	~SparkMaxRelativeEncoder () override=default
double	GetPosition () const override
double	GetVelocity () const override
REVLibError	SetPosition (double position) override
REVLibError	SetPositionConversionFactor (double factor) override
REVLibError	SetVelocityConversionFactor (double factor) override
double	GetPositionConversionFactor () const override
double	GetVelocityConversionFactor () const override
REVLibError	SetAverageDepth (uint32_t depth) override
REVLibError	SetMeasurementPeriod (uint32_t period_ms) override
uint32_t	GetAverageDepth () const override
uint32_t	GetMeasurementPeriod () const override
uint32_t	GetCountsPerRevolution () const override
REVLibError	SetInverted (bool inverted) override
bool	GetInverted () const override
Public Member Functions inherited from rev::RelativeEncoder
virtual	~RelativeEncoder ()
Public Member Functions inherited from rev::CANEncoder
virtual	~CANEncoder ()
Public Member Functions inherited from rev::MotorFeedbackSensor
virtual	~MotorFeedbackSensor ()
Public Member Functions inherited from rev::CANSensor
virtual	~CANSensor ()

Friends
class	CANSparkBase

Detailed Description

Get an instance of this class by using CANSparkBase::GetEncoder() or CANSparkBase::GetEncoder(SparkRelativeEncoder::Type, int).

Member Enumeration Documentation

Type

enum class rev::SparkRelativeEncoder::Type

strong

The type of encoder connected to a SPARK

Enumerator
kNoSensor
kHallSensor
kQuadrature

Constructor & Destructor Documentation

SparkRelativeEncoder() [1/2]

rev::SparkRelativeEncoder::SparkRelativeEncoder ( SparkRelativeEncoder &&  rhs )

default

SparkRelativeEncoder() [2/2]

rev::SparkRelativeEncoder::SparkRelativeEncoder ( const SparkRelativeEncoder &  rhs )

default

~SparkRelativeEncoder()

rev::SparkRelativeEncoder::~SparkRelativeEncoder ( )

overridedefault

Member Function Documentation

operator=()

SparkRelativeEncoder & rev::SparkRelativeEncoder::operator= ( SparkRelativeEncoder &&  rhs )

default

Friends And Related Function Documentation

CANSparkBase

friend class CANSparkBase

friend

---

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

• src/main/native/include/rev/SparkRelativeEncoder.h
• src/main/native/cpp/SparkRelativeEncoder.cpp