ctre::phoenix6::configs::ParentConfiguration Class Reference

Common interface for all configuration objects. More...

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

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

Public Member Functions
virtual std::string	ToString () const =0
virtual std::string	Serialize () const =0
	Serialize this configuration into a string.
virtual ctre::phoenix::StatusCode	Deserialize (std::string const &string)=0
	Deserialize this configuration from a string.

Friends
std::ostream &	operator<< (std::ostream &str, ParentConfiguration const &v)

Detailed Description

Common interface for all configuration objects.

Member Function Documentation

Deserialize()

virtual ctre::phoenix::StatusCode ctre::phoenix6::configs::ParentConfiguration::Deserialize ( std::string const & string )

pure virtual

Deserialize this configuration from a string.

Parameters

string

The serialized configuration

Returns

Status code of the deserialization

Implemented in ctre::phoenix6::configs::AudioConfigs, ctre::phoenix6::configs::CANcoderConfiguration, ctre::phoenix6::configs::CANdiConfiguration, ctre::phoenix6::configs::CANdleConfiguration, ctre::phoenix6::configs::CANdleFeaturesConfigs, ctre::phoenix6::configs::CANrangeConfiguration, ctre::phoenix6::configs::ClosedLoopGeneralConfigs, ctre::phoenix6::configs::ClosedLoopRampsConfigs, ctre::phoenix6::configs::CommutationConfigs, ctre::phoenix6::configs::CurrentLimitsConfigs, ctre::phoenix6::configs::CustomBrushlessMotorConfigs, ctre::phoenix6::configs::CustomParamsConfigs, ctre::phoenix6::configs::DifferentialConstantsConfigs, ctre::phoenix6::configs::DifferentialSensorsConfigs, ctre::phoenix6::configs::DigitalInputsConfigs, ctre::phoenix6::configs::EmptyConfiguration, ctre::phoenix6::configs::ExternalFeedbackConfigs, ctre::phoenix6::configs::ExternalTempConfigs, ctre::phoenix6::configs::FeedbackConfigs, ctre::phoenix6::configs::FovParamsConfigs, ctre::phoenix6::configs::GyroTrimConfigs, ctre::phoenix6::configs::HardwareLimitSwitchConfigs, ctre::phoenix6::configs::LEDConfigs, ctre::phoenix6::configs::MagnetSensorConfigs, ctre::phoenix6::configs::MotionMagicConfigs, ctre::phoenix6::configs::MotorOutputConfigs, ctre::phoenix6::configs::MountPoseConfigs, ctre::phoenix6::configs::OpenLoopRampsConfigs, ctre::phoenix6::configs::Pigeon2Configuration, ctre::phoenix6::configs::Pigeon2FeaturesConfigs, ctre::phoenix6::configs::ProximityParamsConfigs, ctre::phoenix6::configs::PWM1Configs, ctre::phoenix6::configs::PWM2Configs, ctre::phoenix6::configs::QuadratureConfigs, ctre::phoenix6::configs::Slot0Configs, ctre::phoenix6::configs::Slot1Configs, ctre::phoenix6::configs::Slot2Configs, ctre::phoenix6::configs::SlotConfigs, ctre::phoenix6::configs::SoftwareLimitSwitchConfigs, ctre::phoenix6::configs::TalonFXConfiguration, ctre::phoenix6::configs::TalonFXSConfiguration, ctre::phoenix6::configs::ToFParamsConfigs, ctre::phoenix6::configs::TorqueCurrentConfigs, and ctre::phoenix6::configs::VoltageConfigs.

Serialize()

virtual std::string ctre::phoenix6::configs::ParentConfiguration::Serialize ( ) const

pure virtual

Serialize this configuration into a string.

Returns

Serialized configuration

Implemented in ctre::phoenix6::configs::AudioConfigs, ctre::phoenix6::configs::CANcoderConfiguration, ctre::phoenix6::configs::CANdiConfiguration, ctre::phoenix6::configs::CANdleConfiguration, ctre::phoenix6::configs::CANdleFeaturesConfigs, ctre::phoenix6::configs::CANrangeConfiguration, ctre::phoenix6::configs::ClosedLoopGeneralConfigs, ctre::phoenix6::configs::ClosedLoopRampsConfigs, ctre::phoenix6::configs::CommutationConfigs, ctre::phoenix6::configs::CurrentLimitsConfigs, ctre::phoenix6::configs::CustomBrushlessMotorConfigs, ctre::phoenix6::configs::CustomParamsConfigs, ctre::phoenix6::configs::DifferentialConstantsConfigs, ctre::phoenix6::configs::DifferentialSensorsConfigs, ctre::phoenix6::configs::DigitalInputsConfigs, ctre::phoenix6::configs::EmptyConfiguration, ctre::phoenix6::configs::ExternalFeedbackConfigs, ctre::phoenix6::configs::ExternalTempConfigs, ctre::phoenix6::configs::FeedbackConfigs, ctre::phoenix6::configs::FovParamsConfigs, ctre::phoenix6::configs::GyroTrimConfigs, ctre::phoenix6::configs::HardwareLimitSwitchConfigs, ctre::phoenix6::configs::LEDConfigs, ctre::phoenix6::configs::MagnetSensorConfigs, ctre::phoenix6::configs::MotionMagicConfigs, ctre::phoenix6::configs::MotorOutputConfigs, ctre::phoenix6::configs::MountPoseConfigs, ctre::phoenix6::configs::OpenLoopRampsConfigs, ctre::phoenix6::configs::Pigeon2Configuration, ctre::phoenix6::configs::Pigeon2FeaturesConfigs, ctre::phoenix6::configs::ProximityParamsConfigs, ctre::phoenix6::configs::PWM1Configs, ctre::phoenix6::configs::PWM2Configs, ctre::phoenix6::configs::QuadratureConfigs, ctre::phoenix6::configs::Slot0Configs, ctre::phoenix6::configs::Slot1Configs, ctre::phoenix6::configs::Slot2Configs, ctre::phoenix6::configs::SlotConfigs, ctre::phoenix6::configs::SoftwareLimitSwitchConfigs, ctre::phoenix6::configs::TalonFXConfiguration, ctre::phoenix6::configs::TalonFXSConfiguration, ctre::phoenix6::configs::ToFParamsConfigs, ctre::phoenix6::configs::TorqueCurrentConfigs, and ctre::phoenix6::configs::VoltageConfigs.

ToString()

virtual std::string ctre::phoenix6::configs::ParentConfiguration::ToString ( ) const

pure virtual

Implemented in ctre::phoenix6::configs::AudioConfigs, ctre::phoenix6::configs::CANcoderConfiguration, ctre::phoenix6::configs::CANdiConfiguration, ctre::phoenix6::configs::CANdleConfiguration, ctre::phoenix6::configs::CANdleFeaturesConfigs, ctre::phoenix6::configs::CANrangeConfiguration, ctre::phoenix6::configs::ClosedLoopGeneralConfigs, ctre::phoenix6::configs::ClosedLoopRampsConfigs, ctre::phoenix6::configs::CommutationConfigs, ctre::phoenix6::configs::CurrentLimitsConfigs, ctre::phoenix6::configs::CustomBrushlessMotorConfigs, ctre::phoenix6::configs::CustomParamsConfigs, ctre::phoenix6::configs::DifferentialConstantsConfigs, ctre::phoenix6::configs::DifferentialSensorsConfigs, ctre::phoenix6::configs::DigitalInputsConfigs, ctre::phoenix6::configs::EmptyConfiguration, ctre::phoenix6::configs::ExternalFeedbackConfigs, ctre::phoenix6::configs::ExternalTempConfigs, ctre::phoenix6::configs::FeedbackConfigs, ctre::phoenix6::configs::FovParamsConfigs, ctre::phoenix6::configs::GyroTrimConfigs, ctre::phoenix6::configs::HardwareLimitSwitchConfigs, ctre::phoenix6::configs::LEDConfigs, ctre::phoenix6::configs::MagnetSensorConfigs, ctre::phoenix6::configs::MotionMagicConfigs, ctre::phoenix6::configs::MotorOutputConfigs, ctre::phoenix6::configs::MountPoseConfigs, ctre::phoenix6::configs::OpenLoopRampsConfigs, ctre::phoenix6::configs::Pigeon2Configuration, ctre::phoenix6::configs::Pigeon2FeaturesConfigs, ctre::phoenix6::configs::ProximityParamsConfigs, ctre::phoenix6::configs::PWM1Configs, ctre::phoenix6::configs::PWM2Configs, ctre::phoenix6::configs::QuadratureConfigs, ctre::phoenix6::configs::Slot0Configs, ctre::phoenix6::configs::Slot1Configs, ctre::phoenix6::configs::Slot2Configs, ctre::phoenix6::configs::SlotConfigs, ctre::phoenix6::configs::SoftwareLimitSwitchConfigs, ctre::phoenix6::configs::TalonFXConfiguration, ctre::phoenix6::configs::TalonFXSConfiguration, ctre::phoenix6::configs::ToFParamsConfigs, ctre::phoenix6::configs::TorqueCurrentConfigs, and ctre::phoenix6::configs::VoltageConfigs.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & str, ParentConfiguration const & v )

friend

---

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

• ctre/phoenix6/configs/Configuration.hpp