REVLib - C++
SparkMaxLimitSwitch.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018-2024 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#ifdef _MSC_VER
32// Disable deprecation warnings for this file when using VS compiler
33#pragma warning(disable : 4996)
34#endif
35
36#ifdef __GNUC__
37#pragma GCC diagnostic push
38#pragma GCC diagnostic ignored "-Wdeprecated"
39#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
40#endif
41
42#include <wpi/deprecated.h>
43
44#include "rev/CANDigitalInput.h"
45#include "rev/REVLibError.h"
46
47namespace rev {
48
49class CANSparkBase;
50
54class WPI_DEPRECATED("Use SparkLimitSwitch instead") SparkMaxLimitSwitch
55 : public CANDigitalInput {
56 // Friend to allow construction
57 friend class CANSparkBase;
58 friend class SparkLimitSwitch;
59
60public:
67 enum class WPI_DEPRECATED("Use SparkLimitSwitch::Type instead") Type {
68 kNormallyOpen = 0,
69 kNormallyClosed = 1
70 };
71
74
76
77 ~SparkMaxLimitSwitch() override = default;
78
83 bool Get() const override;
84
88 REVLibError EnableLimitSwitch(bool enable) override;
89
93 bool IsLimitSwitchEnabled() const override;
94
95private:
96 enum class Direction { kForward = 0, kReverse = 1 };
97
98 CANSparkBase* m_device;
99 Direction m_direction;
100
101 explicit SparkMaxLimitSwitch(CANSparkBase& device, Direction direction,
102 Type switchType);
103};
104
105} // namespace rev
106
107#ifdef __GNUC__
108#pragma GCC diagnostic pop
109#endif
Definition: CANDigitalInput.h:40
Definition: CANSparkBase.h:72
Definition: SparkLimitSwitch.h:38
Definition: SparkMaxLimitSwitch.h:55
SparkMaxLimitSwitch(const SparkMaxLimitSwitch &)=default
Type
Definition: SparkMaxLimitSwitch.h:67
SparkMaxLimitSwitch(SparkMaxLimitSwitch &&)=default
~SparkMaxLimitSwitch() override=default
SparkMaxLimitSwitch & operator=(SparkMaxLimitSwitch &&)=default
Definition: CANSparkLowLevel.cpp:39
REVLibError
Definition: REVLibError.h:33