mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
8ac45f20bb
Add reference to which VendorDep the class is included in. Add missing OldCommands C++ Documentation (copied from Java).
69 lines
1.5 KiB
C++
69 lines
1.5 KiB
C++
// 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 <string>
|
|
#include <string_view>
|
|
|
|
#include <wpi/sendable/Sendable.h>
|
|
#include <wpi/sendable/SendableHelper.h>
|
|
|
|
#include "frc2/command/Subsystem.h"
|
|
|
|
namespace frc2 {
|
|
/**
|
|
* A base for subsystems that handles registration in the constructor, and
|
|
* provides a more intuitive method for setting the default command.
|
|
*
|
|
* This class is provided by the NewCommands VendorDep
|
|
*/
|
|
class SubsystemBase : public Subsystem,
|
|
public wpi::Sendable,
|
|
public wpi::SendableHelper<SubsystemBase> {
|
|
public:
|
|
void InitSendable(wpi::SendableBuilder& builder) override;
|
|
|
|
/**
|
|
* Gets the name of this Subsystem.
|
|
*
|
|
* @return Name
|
|
*/
|
|
std::string GetName() const;
|
|
|
|
/**
|
|
* Sets the name of this Subsystem.
|
|
*
|
|
* @param name name
|
|
*/
|
|
void SetName(std::string_view name);
|
|
|
|
/**
|
|
* Gets the subsystem name of this Subsystem.
|
|
*
|
|
* @return Subsystem name
|
|
*/
|
|
std::string GetSubsystem() const;
|
|
|
|
/**
|
|
* Sets the subsystem name of this Subsystem.
|
|
*
|
|
* @param name subsystem name
|
|
*/
|
|
void SetSubsystem(std::string_view name);
|
|
|
|
/**
|
|
* Associate a Sendable with this Subsystem.
|
|
* Also update the child's name.
|
|
*
|
|
* @param name name to give child
|
|
* @param child sendable
|
|
*/
|
|
void AddChild(std::string name, wpi::Sendable* child);
|
|
|
|
protected:
|
|
SubsystemBase();
|
|
};
|
|
} // namespace frc2
|