ctre::phoenix6::configs::CustomParamsConfigs Class Reference

Custom Params. More...

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

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

Public Member Functions
constexpr	CustomParamsConfigs ()=default
constexpr CustomParamsConfigs &	WithCustomParam0 (int newCustomParam0)
	Modifies this configuration's CustomParam0 parameter and returns itself for method-chaining and easier to use config API.
constexpr CustomParamsConfigs &	WithCustomParam1 (int newCustomParam1)
	Modifies this configuration's CustomParam1 parameter and returns itself for method-chaining and easier to use config API.
std::string	ToString () const override
std::string	Serialize () const override
ctre::phoenix::StatusCode	Deserialize (const std::string &to_deserialize) override

Public Attributes
int	CustomParam0 = 0
	Custom parameter 0.
int	CustomParam1 = 0
	Custom parameter 1.

Detailed Description

Custom Params.

Custom paramaters that have no real impact on controller.

Constructor & Destructor Documentation

CustomParamsConfigs()

constexpr ctre::phoenix6::configs::CustomParamsConfigs::CustomParamsConfigs ( )

constexprdefault

Member Function Documentation

Deserialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

Serialize()

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

inlineoverridevirtual

Implements ctre::phoenix6::ISerializable.

ToString()

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

inlineoverridevirtual

Implements ctre::phoenix6::configs::ParentConfiguration.

WithCustomParam0()

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

inlineconstexpr

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

newCustomParam0

Parameter to modify

Returns

Itself

WithCustomParam1()

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

inlineconstexpr

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

newCustomParam1

Parameter 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:

• ctre/phoenix6/configs/Configs.hpp