CTRE Phoenix 6 C++ 26.50.0-alpha-1
Loading...
Searching...
No Matches
ctre::phoenix6::configs::ParentConfigurator Class Reference

The base class for all device configurators. More...

#include <ctre/phoenix6/configs/Configurator.hpp>

Inheritance diagram for ctre::phoenix6::configs::ParentConfigurator:
ctre::phoenix6::configs::CANcoderConfigurator ctre::phoenix6::configs::CANdiConfigurator ctre::phoenix6::configs::CANdleConfigurator ctre::phoenix6::configs::CANrangeConfigurator ctre::phoenix6::configs::Pigeon2Configurator ctre::phoenix6::configs::TalonFXConfigurator ctre::phoenix6::configs::TalonFXSConfigurator

Public Attributes

wpi::units::second_t DefaultTimeoutSeconds {0.100_s}
 The default maximum amount of time to wait for a config.

Protected Member Functions

 ParentConfigurator (hardware::DeviceIdentifier deviceIdentifier)
 ParentConfigurator (ParentConfigurator const &)=delete
ParentConfiguratoroperator= (ParentConfigurator const &)=delete
void ReportIfFrequent () const
ctre::phoenix::StatusCode SetConfigsPrivate (std::string_view serializedString, wpi::units::second_t timeoutSeconds, bool futureProofConfigs, bool overrideIfDuplicate)
ctre::phoenix::StatusCode GetConfigsPrivate (std::string &serializedString, wpi::units::second_t timeoutSeconds) const

Detailed Description

The base class for all device configurators.

Constructor & Destructor Documentation

◆ ParentConfigurator() [1/2]

ctre::phoenix6::configs::ParentConfigurator::ParentConfigurator ( hardware::DeviceIdentifier deviceIdentifier)
inlineprotected

◆ ParentConfigurator() [2/2]

ctre::phoenix6::configs::ParentConfigurator::ParentConfigurator ( ParentConfigurator const & )
protecteddelete

Member Function Documentation

◆ GetConfigsPrivate()

ctre::phoenix::StatusCode ctre::phoenix6::configs::ParentConfigurator::GetConfigsPrivate ( std::string & serializedString,
wpi::units::second_t timeoutSeconds ) const
protected

◆ operator=()

ParentConfigurator & ctre::phoenix6::configs::ParentConfigurator::operator= ( ParentConfigurator const & )
protecteddelete

◆ ReportIfFrequent()

void ctre::phoenix6::configs::ParentConfigurator::ReportIfFrequent ( ) const
protected

◆ SetConfigsPrivate()

ctre::phoenix::StatusCode ctre::phoenix6::configs::ParentConfigurator::SetConfigsPrivate ( std::string_view serializedString,
wpi::units::second_t timeoutSeconds,
bool futureProofConfigs,
bool overrideIfDuplicate )
protected

Member Data Documentation

◆ DefaultTimeoutSeconds

wpi::units::second_t ctre::phoenix6::configs::ParentConfigurator::DefaultTimeoutSeconds {0.100_s}

The default maximum amount of time to wait for a config.


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