REVLib - C++
SparkAbsoluteEncoder.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2021-2025 REV Robotics
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * 3. Neither the name of REV Robotics nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#pragma once
30
31#include "rev/AbsoluteEncoder.h"
32#include "rev/REVLibError.h"
33
34namespace rev::spark {
35
36class SparkBase;
37
43 // Friend to allow construction
44 friend class SparkBase;
45
46public:
49
51
52 ~SparkAbsoluteEncoder() override = default;
53
61 double GetPosition() const override;
62
70 double GetVelocity() const override;
71
72private:
73 SparkBase* m_device;
74
75 explicit SparkAbsoluteEncoder(SparkBase& device);
76};
77
78} // namespace rev::spark
Definition: AbsoluteEncoder.h:33
Definition: SparkAbsoluteEncoder.h:42
~SparkAbsoluteEncoder() override=default
SparkAbsoluteEncoder(const SparkAbsoluteEncoder &rhs)=default
SparkAbsoluteEncoder(SparkAbsoluteEncoder &&rhs)=default
double GetPosition() const override
Definition: SparkAbsoluteEncoder.cpp:42
double GetVelocity() const override
Definition: SparkAbsoluteEncoder.cpp:50
SparkAbsoluteEncoder & operator=(SparkAbsoluteEncoder &&rhs)=default
Definition: SparkBase.h:61
Definition: SparkLowLevel.cpp:40