CTRE Phoenix Pro C++ 23.0.12
ctre::phoenixpro::controls::ControlInfo Class Reference

Information about a control request. More...

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

Public Member Functions

 ControlInfo (std::string name)
 Constructs a new ControlInfo object for the control request of the given name. More...
 
std::map< std::string, std::string > & GetNameValues ()
 Gets the map of control parameter names to the corresponding applied value. More...
 
const std::map< std::string, std::string > & GetNameValues () const
 Gets the map of control parameter names to the corresponding applied value. More...
 

Detailed Description

Information about a control request.

This type contains a map that maps control parameter names to the corresponding applied value. Users can iterate through the map to look at the applied control parameters of the control request.

Constructor & Destructor Documentation

◆ ControlInfo()

ctre::phoenixpro::controls::ControlInfo::ControlInfo ( std::string  name)
inline

Constructs a new ControlInfo object for the control request of the given name.

This is constructed by the ControlRequest class and can be accessed by calling ControlRequest::GetControlInfo.

Parameters
nameName of the control request

Member Function Documentation

◆ GetNameValues() [1/2]

std::map< std::string, std::string > & ctre::phoenixpro::controls::ControlInfo::GetNameValues ( )
inline

Gets the map of control parameter names to the corresponding applied value.

Returns
Map of control parameter names and corresponding applied values

◆ GetNameValues() [2/2]

const std::map< std::string, std::string > & ctre::phoenixpro::controls::ControlInfo::GetNameValues ( ) const
inline

Gets the map of control parameter names to the corresponding applied value.

Returns
Map of control parameter names and corresponding applied values

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