ctre::phoenixpro::controls::ControlRequest Class Reference

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

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

Inheritance diagram for ctre::phoenixpro::controls::ControlRequest:

Public Member Functions
	ControlRequest (std::string name)
	Constructs a new Control Request with the given name. More...
ControlInfo &	GetControlInfo ()
	Gets information about this control request. More...
const ControlInfo &	GetControlInfo () 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
ControlRequest &	operator= (ControlRequest const &)=default
ControlRequest &	operator= (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::phoenixpro::controls::ControlRequest::ControlRequest ( ControlRequest const &  )

protecteddefault

ControlRequest() [2/3]

ctre::phoenixpro::controls::ControlRequest::ControlRequest ( ControlRequest &&  )

protecteddefault

ControlRequest() [3/3]

ctre::phoenixpro::controls::ControlRequest::ControlRequest ( std::string  name )

inline

Constructs a new Control Request with the given name.

Parameters

name	Name of the control request

~ControlRequest()

virtual ctre::phoenixpro::controls::ControlRequest::~ControlRequest ( )

virtualdefault

Member Function Documentation

GetControlInfo() [1/2]

ControlInfo & ctre::phoenixpro::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::phoenixpro::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::phoenixpro::controls::ControlRequest::operator= ( ControlRequest &&  )

protecteddefault

operator=() [2/2]

ControlRequest & ctre::phoenixpro::controls::ControlRequest::operator= ( ControlRequest const &  )

protecteddefault

ToString()

virtual std::string ctre::phoenixpro::controls::ControlRequest::ToString ( ) const

pure virtual

Implemented in ctre::phoenixpro::controls::CoastOut, ctre::phoenixpro::controls::DutyCycleOut, ctre::phoenixpro::controls::Follower, ctre::phoenixpro::controls::MotionMagicDutyCycle, ctre::phoenixpro::controls::MotionMagicTorqueCurrentFOC, ctre::phoenixpro::controls::MotionMagicVoltage, ctre::phoenixpro::controls::NeutralOut, ctre::phoenixpro::controls::PositionDutyCycle, ctre::phoenixpro::controls::PositionTorqueCurrentFOC, ctre::phoenixpro::controls::PositionVoltage, ctre::phoenixpro::controls::StaticBrake, ctre::phoenixpro::controls::StrictFollower, ctre::phoenixpro::controls::TorqueCurrentFOC, ctre::phoenixpro::controls::VelocityDutyCycle, ctre::phoenixpro::controls::VelocityTorqueCurrentFOC, ctre::phoenixpro::controls::VelocityVoltage, ctre::phoenixpro::controls::VoltageOut, and ctre::phoenixpro::controls::EmptyControl.

Member Data Documentation

requestReference

ControlInfo ctre::phoenixpro::controls::ControlRequest::requestReference

protected

---

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

• ctre/phoenixpro/controls/ControlRequest.hpp