mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
This deals with the majority of the user-facing code in wpilibC++Devices and a substantial portion of it in wpilibC++. wpilibC++Sim and wpilibC++IntegrationTests are untouched except where it is necessary to make them work with the rest of the libraries. There is still a lot to do in the following areas: -The HAL (which we may not want to touch at all). -The I2C, Serial, and SPI interfaces in wpilibC++Devices, which I haven't gotten around to doing yet. -Most wpilibC++Devices classes have void* pointers for interacting with the HAL. -InterruptableSensorBase passes a void *params for the interrupt handler. -I haven't converted all the const char* to std::strings. -There are plenty of other cases of raw pointers still existing. -This doesn't fall directly under raw pointer stuff, but move syntax and rvalue references could be introduced in many places. -I haven't touched vision code. -The Resource classes conflict (one is in the hal, the other in wpilibC++). Someone should figure out a more permanent fix (eg, just renaming them), then doing what I did (making a new namespace for one of them, essentially the same as renaming it). A few other things: -I created a NullDeleter class which is marked as deprecated. What this does is it can be passed as the deleter to a std::shared_ptr so that when you are converting raw pointers to shared_ptrs the shared_ptr doesn't do any deletion if someone else owns the raw pointer. This should only be used in making old raw pointer UIs. -I had to alter the build.gradle so that it did not emit errors when deprecated functions called deprecated functions. Unfortunately, gradle doesn't appear to be actually printing out gcc warnigns for some reason. The best way I have found to fix this is to patch the toolchains (https://bitbucket.org/byteit101/toolchain-builder/pull-request/5/make-gcc-not-throw-warnings-for-nested/diff) so that a deprecated function calling a deprecated function is fine but a non-deprecated function calling a deprecated function will throw a warning (which we then elevate with -Werror). I believe that clang deals with this properly, although I have not tried it myself. Change-Id: Ib8090c66893576fe73654f4e9d268f9d37be06a2
123 lines
4.9 KiB
C++
123 lines
4.9 KiB
C++
/*----------------------------------------------------------------------------*/
|
|
/* Copyright (c) FIRST 2008. All Rights Reserved.
|
|
*/
|
|
/* Open Source Software - may be modified and shared by FRC teams. The code */
|
|
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib. */
|
|
/*----------------------------------------------------------------------------*/
|
|
#pragma once
|
|
|
|
#include "HAL/HAL.hpp"
|
|
#include "AnalogTriggerOutput.h"
|
|
#include "CounterBase.h"
|
|
#include "SensorBase.h"
|
|
#include "LiveWindow/LiveWindowSendable.h"
|
|
|
|
#include <memory>
|
|
|
|
/**
|
|
* Class for counting the number of ticks on a digital input channel.
|
|
* This is a general purpose class for counting repetitive events. It can return
|
|
* the number
|
|
* of counts, the period of the most recent cycle, and detect when the signal
|
|
* being counted
|
|
* has stopped by supplying a maximum cycle time.
|
|
*
|
|
* All counters will immediately start counting - Reset() them if you need them
|
|
* to be zeroed before use.
|
|
*/
|
|
class Counter : public SensorBase,
|
|
public CounterBase,
|
|
public LiveWindowSendable {
|
|
public:
|
|
explicit Counter(Mode mode = kTwoPulse);
|
|
explicit Counter(int32_t channel);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated; if you just want to construct a Counter "
|
|
"with its own DigitalSource, then call the Counter(int channel). If you "
|
|
"want to keep your own copy of the DigitalSource, use "
|
|
"std::shared_ptr.")]]
|
|
explicit Counter(DigitalSource *source);
|
|
explicit Counter(::std::shared_ptr<DigitalSource> source);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated. Use pass-by-reference instead.")]]
|
|
explicit Counter(AnalogTrigger *trigger);
|
|
explicit Counter(const AnalogTrigger &trigger);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated; prefer to use shared_ptr instead.")]]
|
|
Counter(EncodingType encodingType, DigitalSource *upSource,
|
|
DigitalSource *downSource, bool inverted);
|
|
Counter(EncodingType encodingType, ::std::shared_ptr<DigitalSource> upSource,
|
|
::std::shared_ptr<DigitalSource> downSource, bool inverted);
|
|
virtual ~Counter();
|
|
|
|
void SetUpSource(int32_t channel);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated; prefer to call either SetUpSource(int) or "
|
|
"SetUpSource(shared_ptr).")]]
|
|
void SetUpSource(AnalogTrigger *analogTrigger, AnalogTriggerType triggerType);
|
|
void SetUpSource(::std::shared_ptr<AnalogTrigger> analogTrigger,
|
|
AnalogTriggerType triggerType);
|
|
[[deprecated("Raw pointers are deprecated. Use std::shared_ptr instead.")]]
|
|
void SetUpSource(DigitalSource *source);
|
|
void SetUpSource(::std::shared_ptr<DigitalSource> source);
|
|
[[deprecated("References are deprecated. Use std::shared_ptr instead.")]]
|
|
void SetUpSource(DigitalSource &source);
|
|
void SetUpSourceEdge(bool risingEdge, bool fallingEdge);
|
|
void ClearUpSource();
|
|
|
|
void SetDownSource(int32_t channel);
|
|
[[deprecated(
|
|
"Raw pointers are deprecated; prefer to call either SetDownSource(int) "
|
|
"or SetDownSource(shared_ptr).")]]
|
|
void SetDownSource(AnalogTrigger *analogTrigger,
|
|
AnalogTriggerType triggerType);
|
|
void SetDownSource(::std::shared_ptr<AnalogTrigger> analogTrigger,
|
|
AnalogTriggerType triggerType);
|
|
[[deprecated("Raw pointers are deprecated. Use std::shared_ptr instead.")]]
|
|
void SetDownSource(DigitalSource *source);
|
|
void SetDownSource(::std::shared_ptr<DigitalSource> source);
|
|
[[deprecated("References are deprecated. Use std::shared_ptr instead.")]]
|
|
void SetDownSource(DigitalSource &source);
|
|
void SetDownSourceEdge(bool risingEdge, bool fallingEdge);
|
|
void ClearDownSource();
|
|
|
|
void SetUpDownCounterMode();
|
|
void SetExternalDirectionMode();
|
|
void SetSemiPeriodMode(bool highSemiPeriod);
|
|
void SetPulseLengthMode(float threshold);
|
|
|
|
void SetReverseDirection(bool reverseDirection);
|
|
|
|
// CounterBase interface
|
|
int32_t Get() const override;
|
|
void Reset() override;
|
|
double GetPeriod() const override;
|
|
void SetMaxPeriod(double maxPeriod) override;
|
|
void SetUpdateWhenEmpty(bool enabled);
|
|
bool GetStopped() const override;
|
|
bool GetDirection() const override;
|
|
|
|
void SetSamplesToAverage(int samplesToAverage);
|
|
int GetSamplesToAverage() const;
|
|
uint32_t GetFPGAIndex() const { return m_index; }
|
|
|
|
void UpdateTable() override;
|
|
void StartLiveWindowMode() override;
|
|
void StopLiveWindowMode() override;
|
|
virtual std::string GetSmartDashboardType() const override;
|
|
void InitTable(::std::shared_ptr<ITable> subTable) override;
|
|
::std::shared_ptr<ITable> GetTable() const override;
|
|
|
|
protected:
|
|
// Makes the counter count up.
|
|
::std::shared_ptr<DigitalSource> m_upSource;
|
|
// Makes the counter count down.
|
|
::std::shared_ptr<DigitalSource> m_downSource;
|
|
// The FPGA counter object
|
|
void *m_counter = nullptr; ///< The FPGA counter object.
|
|
private:
|
|
uint32_t m_index = 0; ///< The index of this counter.
|
|
|
|
::std::shared_ptr<ITable> m_table = nullptr;
|
|
};
|