CTRE Phoenix 6 C++ 24.3.0
ctre::phoenix6::configs::CustomParamsConfigs Class Reference

Custom Params. More...

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

Inheritance diagram for ctre::phoenix6::configs::CustomParamsConfigs:
ctre::phoenix6::configs::ParentConfiguration ctre::phoenix6::ISerializable

Public Member Functions

CustomParamsConfigsWithCustomParam0 (int newCustomParam0)
 Modifies this configuration's CustomParam0 parameter and returns itself for method-chaining and easier to use config API. More...
 
CustomParamsConfigsWithCustomParam1 (int newCustomParam1)
 Modifies this configuration's CustomParam1 parameter and returns itself for method-chaining and easier to use config API. More...
 
std::string ToString () const override
 
std::string Serialize () const override
 
ctre::phoenix::StatusCode Deserialize (const std::string &to_deserialize) override
 
virtual std::string ToString () const =0
 
virtual ctre::phoenix::StatusCode Deserialize (const std::string &string)=0
 
virtual std::string Serialize () const =0
 

Public Attributes

int CustomParam0 = 0
 Custom parameter 0. More...
 
int CustomParam1 = 0
 Custom parameter 1. More...
 

Detailed Description

Custom Params.

Custom paramaters that have no real impact on controller.

Member Function Documentation

◆ Deserialize()

ctre::phoenix::StatusCode ctre::phoenix6::configs::CustomParamsConfigs::Deserialize ( const std::string &  to_deserialize)
inlineoverridevirtual

◆ Serialize()

std::string ctre::phoenix6::configs::CustomParamsConfigs::Serialize ( ) const
inlineoverridevirtual

◆ ToString()

std::string ctre::phoenix6::configs::CustomParamsConfigs::ToString ( ) const
inlineoverridevirtual

◆ WithCustomParam0()

CustomParamsConfigs & ctre::phoenix6::configs::CustomParamsConfigs::WithCustomParam0 ( int  newCustomParam0)
inline

Modifies this configuration's CustomParam0 parameter and returns itself for method-chaining and easier to use config API.

Custom parameter 0. This is provided to allow end-applications to store persistent information in the device.

  • Minimum Value: -32768
  • Maximum Value: 32767
  • Default Value: 0
  • Units:
Parameters
newCustomParam0Parameter to modify
Returns
Itself

◆ WithCustomParam1()

CustomParamsConfigs & ctre::phoenix6::configs::CustomParamsConfigs::WithCustomParam1 ( int  newCustomParam1)
inline

Modifies this configuration's CustomParam1 parameter and returns itself for method-chaining and easier to use config API.

Custom parameter 1. This is provided to allow end-applications to store persistent information in the device.

  • Minimum Value: -32768
  • Maximum Value: 32767
  • Default Value: 0
  • Units:
Parameters
newCustomParam1Parameter to modify
Returns
Itself

Member Data Documentation

◆ CustomParam0

int ctre::phoenix6::configs::CustomParamsConfigs::CustomParam0 = 0

Custom parameter 0.

This is provided to allow end-applications to store persistent information in the device.

  • Minimum Value: -32768
  • Maximum Value: 32767
  • Default Value: 0
  • Units:

◆ CustomParam1

int ctre::phoenix6::configs::CustomParamsConfigs::CustomParam1 = 0

Custom parameter 1.

This is provided to allow end-applications to store persistent information in the device.

  • Minimum Value: -32768
  • Maximum Value: 32767
  • Default Value: 0
  • Units:

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