wpilibc/src/main/native/include/frc/smartdashboard/SendableBase.h

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.

#pragma once

#include <wpi/deprecated.h>

#include "frc/smartdashboard/Sendable.h"
#include "frc/smartdashboard/SendableHelper.h"

namespace frc {

class SendableBase : public Sendable, public SendableHelper<SendableBase> {
 public:
  /**
   * Creates an instance of the sensor base
   *
   * @deprecated use Sendable and SendableHelper
   *
   * @param addLiveWindow if true, add this Sendable to LiveWindow
   */
  WPI_DEPRECATED("use Sendable and SendableHelper")
  explicit SendableBase(bool addLiveWindow = true);
};

}  // namespace frc
Remove year from file copyright message (NFC) (#2972) Also update copyright to include "and other WPILib contributors" and clarify license referral language to not be restricted to FIRST teams. 2020-12-26 14:12:05 -08:00			`// Copyright (c) FIRST and other WPILib contributors.`
			`// Open Source Software; you can modify and/or share it under the terms of`
			`// the WPILib BSD license file in the root directory of this project.`
Update LiveWindow to provide continuous telemetry. (#771) LiveWindow.updateValues() is now called from IterativeRobotBase on every loop iteration. Telemetry for all WPILib classes is enabled by default; it can be disabled for specific classes using LiveWindow.disableTelemetry(), or all telemetry can be disabled using LiveWindow.disableAllTelemetry(). This necessitated changing the hook methodology into other classes to be more property-based rather than each class providing multiple functions. This had the benefit of reducing boilerplate and increasing consistency. - Remove NamedSendable, add name to Sendable. - Provide SendableBase abstract class. - Deprecate LiveWindow addSensor/addActuator interfaces. - Add LiveWindow support to drive classes. - Add addChild() helper functions to Subsystem. - Fix inheritance hierarchy. Now only sensors inherit from SensorBase. Other devices inherit from some combination of SendableBase, ErrorBase, or nothing. 2017-12-04 23:28:33 -08:00
			`#pragma once`

Simplify Sendable interface (#1864) This removes the name and subsystem from individual objects, and instead puts this data into a new singleton class, SendableRegistry. Much of LiveWindow has been refactored into SendableRegistry. In C++, a new CRTP helper class, SendableHelper, has been added to provide move and destruction functionality. Shims for GetName, SetName, GetSubsystem, and SetSubsystem have been added to Command and Subsystem (both old and new), and also to SendableHelper to prevent code breakage. This deprecates SendableBase in preparation for future removal. 2019-09-14 15:22:54 -05:00			`#include <wpi/deprecated.h>`
Update LiveWindow to provide continuous telemetry. (#771) LiveWindow.updateValues() is now called from IterativeRobotBase on every loop iteration. Telemetry for all WPILib classes is enabled by default; it can be disabled for specific classes using LiveWindow.disableTelemetry(), or all telemetry can be disabled using LiveWindow.disableAllTelemetry(). This necessitated changing the hook methodology into other classes to be more property-based rather than each class providing multiple functions. This had the benefit of reducing boilerplate and increasing consistency. - Remove NamedSendable, add name to Sendable. - Provide SendableBase abstract class. - Deprecate LiveWindow addSensor/addActuator interfaces. - Add LiveWindow support to drive classes. - Add addChild() helper functions to Subsystem. - Fix inheritance hierarchy. Now only sensors inherit from SensorBase. Other devices inherit from some combination of SendableBase, ErrorBase, or nothing. 2017-12-04 23:28:33 -08:00
Move CameraServer and WPILib headers into their own folder The old headers were moved into folders because doing so avoids polluting the system include directories. Folder names were also normalized to lowercase. 2018-07-20 00:03:45 -07:00			`#include "frc/smartdashboard/Sendable.h"`
Simplify Sendable interface (#1864) This removes the name and subsystem from individual objects, and instead puts this data into a new singleton class, SendableRegistry. Much of LiveWindow has been refactored into SendableRegistry. In C++, a new CRTP helper class, SendableHelper, has been added to provide move and destruction functionality. Shims for GetName, SetName, GetSubsystem, and SetSubsystem have been added to Command and Subsystem (both old and new), and also to SendableHelper to prevent code breakage. This deprecates SendableBase in preparation for future removal. 2019-09-14 15:22:54 -05:00			`#include "frc/smartdashboard/SendableHelper.h"`
Update LiveWindow to provide continuous telemetry. (#771) LiveWindow.updateValues() is now called from IterativeRobotBase on every loop iteration. Telemetry for all WPILib classes is enabled by default; it can be disabled for specific classes using LiveWindow.disableTelemetry(), or all telemetry can be disabled using LiveWindow.disableAllTelemetry(). This necessitated changing the hook methodology into other classes to be more property-based rather than each class providing multiple functions. This had the benefit of reducing boilerplate and increasing consistency. - Remove NamedSendable, add name to Sendable. - Provide SendableBase abstract class. - Deprecate LiveWindow addSensor/addActuator interfaces. - Add LiveWindow support to drive classes. - Add addChild() helper functions to Subsystem. - Fix inheritance hierarchy. Now only sensors inherit from SensorBase. Other devices inherit from some combination of SendableBase, ErrorBase, or nothing. 2017-12-04 23:28:33 -08:00
			`namespace frc {`

Simplify Sendable interface (#1864) This removes the name and subsystem from individual objects, and instead puts this data into a new singleton class, SendableRegistry. Much of LiveWindow has been refactored into SendableRegistry. In C++, a new CRTP helper class, SendableHelper, has been added to provide move and destruction functionality. Shims for GetName, SetName, GetSubsystem, and SetSubsystem have been added to Command and Subsystem (both old and new), and also to SendableHelper to prevent code breakage. This deprecates SendableBase in preparation for future removal. 2019-09-14 15:22:54 -05:00			`class SendableBase : public Sendable, public SendableHelper<SendableBase> {`
Update LiveWindow to provide continuous telemetry. (#771) LiveWindow.updateValues() is now called from IterativeRobotBase on every loop iteration. Telemetry for all WPILib classes is enabled by default; it can be disabled for specific classes using LiveWindow.disableTelemetry(), or all telemetry can be disabled using LiveWindow.disableAllTelemetry(). This necessitated changing the hook methodology into other classes to be more property-based rather than each class providing multiple functions. This had the benefit of reducing boilerplate and increasing consistency. - Remove NamedSendable, add name to Sendable. - Provide SendableBase abstract class. - Deprecate LiveWindow addSensor/addActuator interfaces. - Add LiveWindow support to drive classes. - Add addChild() helper functions to Subsystem. - Fix inheritance hierarchy. Now only sensors inherit from SensorBase. Other devices inherit from some combination of SendableBase, ErrorBase, or nothing. 2017-12-04 23:28:33 -08:00			`public:`
Moved C++ comments from source files to headers (#1111) Also sorted functions in C++ sources to match order in related headers. 2018-05-31 20:47:15 -07:00			`/**`
[wpilibc] Add doxygen deprecated tag to deprecated methods (#2336) 2020-03-31 20:43:04 -07:00			`* Creates an instance of the sensor base`
			`*`
			`* @deprecated use Sendable and SendableHelper`
Moved C++ comments from source files to headers (#1111) Also sorted functions in C++ sources to match order in related headers. 2018-05-31 20:47:15 -07:00			`*`
			`* @param addLiveWindow if true, add this Sendable to LiveWindow`
			`*/`
Simplify Sendable interface (#1864) This removes the name and subsystem from individual objects, and instead puts this data into a new singleton class, SendableRegistry. Much of LiveWindow has been refactored into SendableRegistry. In C++, a new CRTP helper class, SendableHelper, has been added to provide move and destruction functionality. Shims for GetName, SetName, GetSubsystem, and SetSubsystem have been added to Command and Subsystem (both old and new), and also to SendableHelper to prevent code breakage. This deprecates SendableBase in preparation for future removal. 2019-09-14 15:22:54 -05:00			`WPI_DEPRECATED("use Sendable and SendableHelper")`
Update LiveWindow to provide continuous telemetry. (#771) LiveWindow.updateValues() is now called from IterativeRobotBase on every loop iteration. Telemetry for all WPILib classes is enabled by default; it can be disabled for specific classes using LiveWindow.disableTelemetry(), or all telemetry can be disabled using LiveWindow.disableAllTelemetry(). This necessitated changing the hook methodology into other classes to be more property-based rather than each class providing multiple functions. This had the benefit of reducing boilerplate and increasing consistency. - Remove NamedSendable, add name to Sendable. - Provide SendableBase abstract class. - Deprecate LiveWindow addSensor/addActuator interfaces. - Add LiveWindow support to drive classes. - Add addChild() helper functions to Subsystem. - Fix inheritance hierarchy. Now only sensors inherit from SensorBase. Other devices inherit from some combination of SendableBase, ErrorBase, or nothing. 2017-12-04 23:28:33 -08:00			`explicit SendableBase(bool addLiveWindow = true);`
			`};`

			`} // namespace frc`