CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::controls::ControlRequest Class Referenceabstract

Abstract Control Request class that other control requests extend for use. More...

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

Inheritance diagram for ctre::phoenix6::controls::ControlRequest:
ctre::phoenix6::controls::CoastOut ctre::phoenix6::controls::DifferentialDutyCycle ctre::phoenix6::controls::DifferentialFollower ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle 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::DynamicMotionMagicTorqueCurrentFOC ctre::phoenix6::controls::DynamicMotionMagicVoltage ctre::phoenix6::controls::EmptyControl ctre::phoenix6::controls::Follower 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::StaticBrake ctre::phoenix6::controls::StrictFollower ctre::phoenix6::controls::TorqueCurrentFOC ctre::phoenix6::controls::VelocityDutyCycle ctre::phoenix6::controls::VelocityTorqueCurrentFOC ctre::phoenix6::controls::VelocityVoltage ctre::phoenix6::controls::VoltageOut

Public Member Functions

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

Protected Member Functions

 ControlRequest (ControlRequest const &)=default
 
 ControlRequest (ControlRequest &&)=default
 
ControlRequestoperator= (ControlRequest const &)=default
 
ControlRequestoperator= (ControlRequest &&)=default
 

Protected Attributes

std::string name
 

Detailed Description

Abstract Control Request class that other control requests extend for use.

Constructor & Destructor Documentation

◆ ControlRequest() [1/3]

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

◆ ControlRequest() [2/3]

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

◆ ControlRequest() [3/3]

ctre::phoenix6::controls::ControlRequest::ControlRequest ( std::string  name)
inline

Constructs a new Control Request with the given name.

Parameters
nameName of the control request

◆ ~ControlRequest()

virtual ctre::phoenix6::controls::ControlRequest::~ControlRequest ( )
virtualdefault

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::DifferentialDutyCycle, ctre::phoenix6::controls::DifferentialFollower, ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle, 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::DynamicMotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicVoltage, ctre::phoenix6::controls::Follower, 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::StaticBrake, ctre::phoenix6::controls::StrictFollower, ctre::phoenix6::controls::TorqueCurrentFOC, ctre::phoenix6::controls::VelocityDutyCycle, ctre::phoenix6::controls::VelocityTorqueCurrentFOC, ctre::phoenix6::controls::VelocityVoltage, ctre::phoenix6::controls::VoltageOut, and ctre::phoenix6::controls::EmptyControl.

◆ GetName()

std::string const & ctre::phoenix6::controls::ControlRequest::GetName ( ) const
inline

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ToString()

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

Implemented in ctre::phoenix6::controls::CoastOut, ctre::phoenix6::controls::DifferentialDutyCycle, ctre::phoenix6::controls::DifferentialFollower, ctre::phoenix6::controls::DifferentialMotionMagicDutyCycle, 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::DynamicMotionMagicTorqueCurrentFOC, ctre::phoenix6::controls::DynamicMotionMagicVoltage, ctre::phoenix6::controls::Follower, 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::StaticBrake, ctre::phoenix6::controls::StrictFollower, ctre::phoenix6::controls::TorqueCurrentFOC, ctre::phoenix6::controls::VelocityDutyCycle, ctre::phoenix6::controls::VelocityTorqueCurrentFOC, ctre::phoenix6::controls::VelocityVoltage, ctre::phoenix6::controls::VoltageOut, and ctre::phoenix6::controls::EmptyControl.

Member Data Documentation

◆ name

std::string ctre::phoenix6::controls::ControlRequest::name
protected

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