ctre::phoenix6::controls::EmptyControl Class Reference

Generic Empty Control class used to do nothing. More...

#include <ctre/phoenix6/controls/ControlRequest.hpp>

Inheritance diagram for ctre::phoenix6::controls::EmptyControl:

Public Member Functions
constexpr	EmptyControl ()=default
	Constructs an empty control request.
constexpr	~EmptyControl () override
constexpr std::string_view	GetName () const override
	Gets the name of this control request.
std::string	ToString () const override
std::map< std::string, std::string >	GetControlInfo () const override
	Gets information about this control request.
constexpr EmptyControl &	WithUpdateFreqHz (wpi::units::hertz_t)
Public Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr	ControlRequest ()=default
	Constructs a new Control Request.
virtual constexpr	~ControlRequest ()

Additional Inherited Members
Protected Member Functions inherited from ctre::phoenix6::controls::ControlRequest
constexpr	ControlRequest (ControlRequest const &)=default
constexpr	ControlRequest (ControlRequest &&)=default
constexpr ControlRequest &	operator= (ControlRequest const &)=default
constexpr ControlRequest &	operator= (ControlRequest &&)=default

Detailed Description

Generic Empty Control class used to do nothing.

Constructor & Destructor Documentation

EmptyControl()

ctre::phoenix6::controls::EmptyControl::EmptyControl ( )

constexprdefault

Constructs an empty control request.

~EmptyControl()

ctre::phoenix6::controls::EmptyControl::~EmptyControl ( )

inlineconstexproverride

Member Function Documentation

GetControlInfo()

std::map< std::string, std::string > ctre::phoenix6::controls::EmptyControl::GetControlInfo ( ) const

overridevirtual

Gets information about this control request.

Returns

Map of control parameter names and corresponding applied values

Implements ctre::phoenix6::controls::ControlRequest.

GetName()

std::string_view ctre::phoenix6::controls::EmptyControl::GetName ( ) const

inlineconstexproverridevirtual

Gets the name of this control request.

Returns

Name of the control request

Implements ctre::phoenix6::controls::ControlRequest.

ToString()

std::string ctre::phoenix6::controls::EmptyControl::ToString ( ) const

inlineoverridevirtual

Implements ctre::phoenix6::controls::ControlRequest.

WithUpdateFreqHz()

EmptyControl & ctre::phoenix6::controls::EmptyControl::WithUpdateFreqHz ( wpi::units::hertz_t )

inlineconstexpr

---

The documentation for this class was generated from the following file:

• ctre/phoenix6/controls/ControlRequest.hpp