Files
allwpilib/wpilibc/wpilibC++Devices/include/Ultrasonic.h
James Kuszmaul 534ea134a4 artf4154: Get rid of raw pointers in C++.
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
2015-07-20 13:18:29 -04:00

111 lines
3.8 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 "SensorBase.h"
#include "Counter.h"
#include "Task.h"
#include "PIDSource.h"
#include "LiveWindow/LiveWindowSendable.h"
#include <atomic>
#include "HAL/cpp/priority_mutex.h"
#include <memory>
class DigitalInput;
class DigitalOutput;
/**
* Ultrasonic rangefinder class.
* The Ultrasonic rangefinder measures absolute distance based on the round-trip
* time
* of a ping generated by the controller. These sensors use two transducers, a
* speaker and
* a microphone both tuned to the ultrasonic range. A common ultrasonic sensor,
* the Daventech SRF04
* requires a short pulse to be generated on a digital channel. This causes the
* chirp to be
* emmitted. A second line becomes high as the ping is transmitted and goes low
* when
* the echo is received. The time that the line is high determines the round
* trip distance
* (time of flight).
*/
class Ultrasonic : public SensorBase,
public PIDSource,
public LiveWindowSendable {
public:
enum DistanceUnit { kInches = 0, kMilliMeters = 1 };
[[deprecated(
"Raw pointers are deprecated; prefer either specifying the channel "
"numbers as integers or passing shared_ptrs.")]]
Ultrasonic(DigitalOutput *pingChannel, DigitalInput *echoChannel,
DistanceUnit units = kInches);
[[deprecated(
"References are deprecated; prefer either specifying the channel numbers "
"as integers or passing shared_ptrs.")]]
Ultrasonic(DigitalOutput &pingChannel, DigitalInput &echoChannel,
DistanceUnit units = kInches);
Ultrasonic(::std::shared_ptr<DigitalOutput> pingChannel,
::std::shared_ptr<DigitalInput> echoChannel,
DistanceUnit units = kInches);
Ultrasonic(uint32_t pingChannel, uint32_t echoChannel,
DistanceUnit units = kInches);
virtual ~Ultrasonic();
void Ping();
bool IsRangeValid() const;
static void SetAutomaticMode(bool enabling);
double GetRangeInches() const;
double GetRangeMM() const;
bool IsEnabled() const { return m_enabled; }
void SetEnabled(bool enable) { m_enabled = enable; }
double PIDGet() const override;
void SetDistanceUnits(DistanceUnit units);
DistanceUnit GetDistanceUnits() const;
void UpdateTable() override;
void StartLiveWindowMode() override;
void StopLiveWindowMode() override;
std::string GetSmartDashboardType() const override;
void InitTable(::std::shared_ptr<ITable> subTable) override;
::std::shared_ptr<ITable> GetTable() const override;
private:
void Initialize();
static void UltrasonicChecker();
static constexpr double kPingTime =
10 * 1e-6; ///< Time (sec) for the ping trigger pulse.
static const uint32_t kPriority =
64; ///< Priority that the ultrasonic round robin task runs.
static constexpr double kMaxUltrasonicTime =
0.1; ///< Max time (ms) between readings.
static constexpr double kSpeedOfSoundInchesPerSec = 1130.0 * 12.0;
static Task m_task; // task doing the round-robin automatic sensing
static Ultrasonic *m_firstSensor; // head of the ultrasonic sensor list
static std::atomic<bool> m_automaticEnabled; // automatic round robin mode
static priority_mutex m_mutex; // synchronize access to the list of sensors
::std::shared_ptr<DigitalOutput> m_pingChannel;
::std::shared_ptr<DigitalInput> m_echoChannel;
bool m_allocatedChannels;
bool m_enabled;
Counter m_counter;
Ultrasonic *m_nextSensor;
DistanceUnit m_units;
::std::shared_ptr<ITable> m_table = nullptr;
};