Loading [MathJax]/extensions/tex2jax.js
CTRE Phoenix 6 C++ 23.2.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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::DutyCycleOut ctre::phoenix6::controls::EmptyControl ctre::phoenix6::controls::Follower ctre::phoenix6::controls::MotionMagicDutyCycle ctre::phoenix6::controls::MotionMagicTorqueCurrentFOC ctre::phoenix6::controls::MotionMagicVoltage 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...
 
ControlInfoGetControlInfo ()
 Gets information about this control request. More...
 
const ControlInfoGetControlInfo () const
 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

ControlInfo requestReference
 

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() [1/2]

ControlInfo & ctre::phoenix6::controls::ControlRequest::GetControlInfo ( )
inline

Gets information about this control request.

Returns
An instance of ControlInfo containing information about this control request

◆ GetControlInfo() [2/2]

const ControlInfo & ctre::phoenix6::controls::ControlRequest::GetControlInfo ( ) const
inline

Gets information about this control request.

Returns
An instance of ControlInfo containing information about this control request

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ ToString()

Member Data Documentation

◆ requestReference

ControlInfo ctre::phoenix6::controls::ControlRequest::requestReference
protected

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