CTRE Phoenix 6 C++ 26.0.0-beta-1
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
ctre::phoenix6::controls::ControlRequest Class Referenceabstract

Common interface implemented by all control requests. More...

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

Inheritance diagram for ctre::phoenix6::controls::ControlRequest:
ctre::phoenix6::controls::CoastOut ctre::phoenix6::controls::ColorFlowAnimation ctre::phoenix6::controls::DifferentialDutyCycle ctre::phoenix6::controls::DifferentialFollower ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle ctre::phoenix6::controls::DifferentialMotionMagicExpoDutyCycle ctre::phoenix6::controls::DifferentialMotionMagicExpoVoltage ctre::phoenix6::controls::DifferentialMotionMagicVelocityDutyCycle ctre::phoenix6::controls::DifferentialMotionMagicVelocityVoltage ctre::phoenix6::controls::DifferentialMotionMagicVoltage ctre::phoenix6::controls::DifferentialPositionDutyCycle ctre::phoenix6::controls::DifferentialPositionVoltage ctre::phoenix6::controls::DifferentialStrictFollower ctre::phoenix6::controls::DifferentialVelocityDutyCycle ctre::phoenix6::controls::DifferentialVelocityVoltage ctre::phoenix6::controls::DifferentialVoltage ctre::phoenix6::controls::DutyCycleOut ctre::phoenix6::controls::DynamicMotionMagicDutyCycle ctre::phoenix6::controls::DynamicMotionMagicExpoDutyCycle ctre::phoenix6::controls::DynamicMotionMagicExpoTorqueCurrentFOC ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage ctre::phoenix6::controls::DynamicMotionMagicTorqueCurrentFOC ctre::phoenix6::controls::DynamicMotionMagicVoltage ctre::phoenix6::controls::EmptyAnimation ctre::phoenix6::controls::EmptyControl ctre::phoenix6::controls::FireAnimation ctre::phoenix6::controls::Follower ctre::phoenix6::controls::LarsonAnimation ctre::phoenix6::controls::ModulateVBatOut ctre::phoenix6::controls::MotionMagicDutyCycle ctre::phoenix6::controls::MotionMagicExpoDutyCycle ctre::phoenix6::controls::MotionMagicExpoTorqueCurrentFOC ctre::phoenix6::controls::MotionMagicExpoVoltage ctre::phoenix6::controls::MotionMagicTorqueCurrentFOC ctre::phoenix6::controls::MotionMagicVelocityDutyCycle ctre::phoenix6::controls::MotionMagicVelocityTorqueCurrentFOC ctre::phoenix6::controls::MotionMagicVelocityVoltage ctre::phoenix6::controls::MotionMagicVoltage ctre::phoenix6::controls::MusicTone ctre::phoenix6::controls::NeutralOut ctre::phoenix6::controls::PositionDutyCycle ctre::phoenix6::controls::PositionTorqueCurrentFOC ctre::phoenix6::controls::PositionVoltage ctre::phoenix6::controls::RainbowAnimation ctre::phoenix6::controls::RgbFadeAnimation ctre::phoenix6::controls::SingleFadeAnimation ctre::phoenix6::controls::SolidColor ctre::phoenix6::controls::StaticBrake ctre::phoenix6::controls::StrictFollower ctre::phoenix6::controls::StrobeAnimation ctre::phoenix6::controls::TorqueCurrentFOC ctre::phoenix6::controls::TwinkleAnimation ctre::phoenix6::controls::TwinkleOffAnimation ctre::phoenix6::controls::VelocityDutyCycle ctre::phoenix6::controls::VelocityTorqueCurrentFOC ctre::phoenix6::controls::VelocityVoltage ctre::phoenix6::controls::VoltageOut

Public Member Functions

constexpr ControlRequest ()=default
 Constructs a new Control Request.
 
virtual constexpr ~ControlRequest ()
 
virtual constexpr std::string_view GetName () const =0
 Gets the name of this control request.
 
virtual std::map< std::string, std::string > GetControlInfo () const =0
 Gets information about this control request.
 
virtual std::string ToString () const =0
 

Protected Member Functions

constexpr ControlRequest (ControlRequest const &)=default
 
constexpr ControlRequest (ControlRequest &&)=default
 
constexpr ControlRequest & operator= (ControlRequest const &)=default
 
constexpr ControlRequest & operator= (ControlRequest &&)=default
 

Detailed Description

Common interface implemented by all control requests.

Constructor & Destructor Documentation

◆ ControlRequest() [1/3]

ctre::phoenix6::controls::ControlRequest::ControlRequest ( ControlRequest const & )
constexprprotecteddefault

◆ ControlRequest() [2/3]

ctre::phoenix6::controls::ControlRequest::ControlRequest ( ControlRequest && )
constexprprotecteddefault

◆ ControlRequest() [3/3]

ctre::phoenix6::controls::ControlRequest::ControlRequest ( )
constexprdefault

Constructs a new Control Request.

◆ ~ControlRequest()

virtual constexpr ctre::phoenix6::controls::ControlRequest::~ControlRequest ( )
inlineconstexprvirtual

Member Function Documentation

◆ GetControlInfo()

virtual std::map< std::string, std::string > ctre::phoenix6::controls::ControlRequest::GetControlInfo ( ) const
pure virtual

Gets information about this control request.

Returns
Map of control parameter names and corresponding applied values

Implemented in ctre::phoenix6::controls::CoastOut, ctre::phoenix6::controls::ColorFlowAnimation, ctre::phoenix6::controls::DifferentialDutyCycle, ctre::phoenix6::controls::DifferentialFollower, ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVelocityDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicVelocityVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVoltage, ctre::phoenix6::controls::DifferentialPositionDutyCycle, ctre::phoenix6::controls::DifferentialPositionVoltage, ctre::phoenix6::controls::DifferentialStrictFollower, ctre::phoenix6::controls::DifferentialVelocityDutyCycle, ctre::phoenix6::controls::DifferentialVelocityVoltage, ctre::phoenix6::controls::DifferentialVoltage, ctre::phoenix6::controls::DutyCycleOut, ctre::phoenix6::controls::DynamicMotionMagicDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage, ctre::phoenix6::controls::DynamicMotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicVoltage, ctre::phoenix6::controls::EmptyAnimation, ctre::phoenix6::controls::EmptyControl, ctre::phoenix6::controls::FireAnimation, ctre::phoenix6::controls::Follower, ctre::phoenix6::controls::LarsonAnimation, ctre::phoenix6::controls::ModulateVBatOut, ctre::phoenix6::controls::MotionMagicDutyCycle, ctre::phoenix6::controls::MotionMagicExpoDutyCycle, ctre::phoenix6::controls::MotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicExpoVoltage, ctre::phoenix6::controls::MotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityDutyCycle, ctre::phoenix6::controls::MotionMagicVelocityTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityVoltage, ctre::phoenix6::controls::MotionMagicVoltage, ctre::phoenix6::controls::MusicTone, ctre::phoenix6::controls::NeutralOut, ctre::phoenix6::controls::PositionDutyCycle, ctre::phoenix6::controls::PositionTorqueCurrentFOC, ctre::phoenix6::controls::PositionVoltage, ctre::phoenix6::controls::RainbowAnimation, ctre::phoenix6::controls::RgbFadeAnimation, ctre::phoenix6::controls::SingleFadeAnimation, ctre::phoenix6::controls::SolidColor, ctre::phoenix6::controls::StaticBrake, ctre::phoenix6::controls::StrictFollower, ctre::phoenix6::controls::StrobeAnimation, ctre::phoenix6::controls::TorqueCurrentFOC, ctre::phoenix6::controls::TwinkleAnimation, ctre::phoenix6::controls::TwinkleOffAnimation, ctre::phoenix6::controls::VelocityDutyCycle, ctre::phoenix6::controls::VelocityTorqueCurrentFOC, ctre::phoenix6::controls::VelocityVoltage, and ctre::phoenix6::controls::VoltageOut.

◆ GetName()

virtual constexpr std::string_view ctre::phoenix6::controls::ControlRequest::GetName ( ) const
constexprpure virtual

Gets the name of this control request.

Returns
Name of the control request

Implemented in ctre::phoenix6::controls::CoastOut, ctre::phoenix6::controls::ColorFlowAnimation, ctre::phoenix6::controls::DifferentialDutyCycle, ctre::phoenix6::controls::DifferentialFollower, ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVelocityDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicVelocityVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVoltage, ctre::phoenix6::controls::DifferentialPositionDutyCycle, ctre::phoenix6::controls::DifferentialPositionVoltage, ctre::phoenix6::controls::DifferentialStrictFollower, ctre::phoenix6::controls::DifferentialVelocityDutyCycle, ctre::phoenix6::controls::DifferentialVelocityVoltage, ctre::phoenix6::controls::DifferentialVoltage, ctre::phoenix6::controls::DutyCycleOut, ctre::phoenix6::controls::DynamicMotionMagicDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage, ctre::phoenix6::controls::DynamicMotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicVoltage, ctre::phoenix6::controls::EmptyAnimation, ctre::phoenix6::controls::EmptyControl, ctre::phoenix6::controls::FireAnimation, ctre::phoenix6::controls::Follower, ctre::phoenix6::controls::LarsonAnimation, ctre::phoenix6::controls::ModulateVBatOut, ctre::phoenix6::controls::MotionMagicDutyCycle, ctre::phoenix6::controls::MotionMagicExpoDutyCycle, ctre::phoenix6::controls::MotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicExpoVoltage, ctre::phoenix6::controls::MotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityDutyCycle, ctre::phoenix6::controls::MotionMagicVelocityTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityVoltage, ctre::phoenix6::controls::MotionMagicVoltage, ctre::phoenix6::controls::MusicTone, ctre::phoenix6::controls::NeutralOut, ctre::phoenix6::controls::PositionDutyCycle, ctre::phoenix6::controls::PositionTorqueCurrentFOC, ctre::phoenix6::controls::PositionVoltage, ctre::phoenix6::controls::RainbowAnimation, ctre::phoenix6::controls::RgbFadeAnimation, ctre::phoenix6::controls::SingleFadeAnimation, ctre::phoenix6::controls::SolidColor, ctre::phoenix6::controls::StaticBrake, ctre::phoenix6::controls::StrictFollower, ctre::phoenix6::controls::StrobeAnimation, ctre::phoenix6::controls::TorqueCurrentFOC, ctre::phoenix6::controls::TwinkleAnimation, ctre::phoenix6::controls::TwinkleOffAnimation, ctre::phoenix6::controls::VelocityDutyCycle, ctre::phoenix6::controls::VelocityTorqueCurrentFOC, ctre::phoenix6::controls::VelocityVoltage, and ctre::phoenix6::controls::VoltageOut.

◆ operator=() [1/2]

ControlRequest & ctre::phoenix6::controls::ControlRequest::operator= ( ControlRequest && )
constexprprotecteddefault

◆ operator=() [2/2]

ControlRequest & ctre::phoenix6::controls::ControlRequest::operator= ( ControlRequest const & )
constexprprotecteddefault

◆ ToString()

virtual std::string ctre::phoenix6::controls::ControlRequest::ToString ( ) const
pure virtual

Implemented in ctre::phoenix6::controls::CoastOut, ctre::phoenix6::controls::ColorFlowAnimation, ctre::phoenix6::controls::DifferentialDutyCycle, ctre::phoenix6::controls::DifferentialFollower, ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicExpoVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVelocityDutyCycle, ctre::phoenix6::controls::DifferentialMotionMagicVelocityVoltage, ctre::phoenix6::controls::DifferentialMotionMagicVoltage, ctre::phoenix6::controls::DifferentialPositionDutyCycle, ctre::phoenix6::controls::DifferentialPositionVoltage, ctre::phoenix6::controls::DifferentialStrictFollower, ctre::phoenix6::controls::DifferentialVelocityDutyCycle, ctre::phoenix6::controls::DifferentialVelocityVoltage, ctre::phoenix6::controls::DifferentialVoltage, ctre::phoenix6::controls::DutyCycleOut, ctre::phoenix6::controls::DynamicMotionMagicDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoDutyCycle, ctre::phoenix6::controls::DynamicMotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicExpoVoltage, ctre::phoenix6::controls::DynamicMotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicVoltage, ctre::phoenix6::controls::EmptyAnimation, ctre::phoenix6::controls::EmptyControl, ctre::phoenix6::controls::FireAnimation, ctre::phoenix6::controls::Follower, ctre::phoenix6::controls::LarsonAnimation, ctre::phoenix6::controls::ModulateVBatOut, ctre::phoenix6::controls::MotionMagicDutyCycle, ctre::phoenix6::controls::MotionMagicExpoDutyCycle, ctre::phoenix6::controls::MotionMagicExpoTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicExpoVoltage, ctre::phoenix6::controls::MotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityDutyCycle, ctre::phoenix6::controls::MotionMagicVelocityTorqueCurrentFOC, ctre::phoenix6::controls::MotionMagicVelocityVoltage, ctre::phoenix6::controls::MotionMagicVoltage, ctre::phoenix6::controls::MusicTone, ctre::phoenix6::controls::NeutralOut, ctre::phoenix6::controls::PositionDutyCycle, ctre::phoenix6::controls::PositionTorqueCurrentFOC, ctre::phoenix6::controls::PositionVoltage, ctre::phoenix6::controls::RainbowAnimation, ctre::phoenix6::controls::RgbFadeAnimation, ctre::phoenix6::controls::SingleFadeAnimation, ctre::phoenix6::controls::SolidColor, ctre::phoenix6::controls::StaticBrake, ctre::phoenix6::controls::StrictFollower, ctre::phoenix6::controls::StrobeAnimation, ctre::phoenix6::controls::TorqueCurrentFOC, ctre::phoenix6::controls::TwinkleAnimation, ctre::phoenix6::controls::TwinkleOffAnimation, ctre::phoenix6::controls::VelocityDutyCycle, ctre::phoenix6::controls::VelocityTorqueCurrentFOC, ctre::phoenix6::controls::VelocityVoltage, and ctre::phoenix6::controls::VoltageOut.

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