SparkMaxRelativeEncoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021-2023 REV Robotics
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of REV Robotics nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#pragma once
 
#include <stdint.h>
 
#include <atomic>
 
#include <wpi/deprecated.h>
 
#include "rev/REVLibError.h"
#include "rev/RelativeEncoder.h"
 
namespace rev {
 
class CANSparkBase;
 
class WPI_DEPRECATED("Use SparkRelativeEncoder instead") SparkMaxRelativeEncoder
    : public RelativeEncoder {
    // Friend to allow construction
    friend class CANSparkBase;
    friend class SparkRelativeEncoder;
 
public:
    enum class WPI_DEPRECATED("Use SparkRelativeEncoder::Type instead") Type {
        kNoSensor = 0,
        kHallSensor = 1,
        kQuadrature = 2
    };
 
    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;
 
private:
    CANSparkBase* m_device;
    int m_countsPerRev;
    Type m_type;
 
    explicit SparkMaxRelativeEncoder(CANSparkBase& device, Type Type,
                                     int countsPerRev);
 
    int GetSparkMaxFeedbackDeviceID() const override;
};
 
}  // namespace rev