REVLib - C++
rev::spark::BaseConfig Class Reference

#include <BaseConfig.h>

Inherited by rev::spark::AbsoluteEncoderConfig, rev::spark::AlternateEncoderConfig, rev::spark::AnalogSensorConfig, rev::spark::ClosedLoopConfig, rev::spark::EncoderConfig, rev::spark::ExternalEncoderConfig, rev::spark::LimitSwitchConfig, rev::spark::MAXMotionConfig, rev::spark::SignalsConfig, rev::spark::SmartMotionConfig, rev::spark::SoftLimitConfig, and rev::spark::SparkBaseConfig.

Public Member Functions

virtual ~BaseConfig ()=default
 
virtual std::string Flatten ()
 

Protected Types

using SparkConfig_t = std::variant< int32_t, uint32_t, float, bool >
 

Protected Member Functions

 BaseConfig ()=default
 
 BaseConfig (const BaseConfig &)=delete
 
BaseConfigoperator= (const BaseConfig &)=delete
 
 BaseConfig (BaseConfig &&) noexcept=delete
 
BaseConfigoperator= (BaseConfig &&) noexcept=delete
 
template<typename ConfigType >
void PutParameter (uint8_t parameterId, ConfigType value)
 
std::optional< SparkConfig_tGetParameter (uint8_t parameterId)
 
std::optional< SparkConfig_tGetParameter (BaseConfig &fromConfig, uint8_t parameterId)
 
void RemoveParameter (uint8_t parameterId)
 
void RemoveParameter (BaseConfig &fromConfig, uint8_t parameterId)
 
void Apply (BaseConfig &config)
 

Member Typedef Documentation

◆ SparkConfig_t

using rev::spark::BaseConfig::SparkConfig_t = std::variant<int32_t, uint32_t, float, bool>
protected

Constructor & Destructor Documentation

◆ ~BaseConfig()

virtual rev::spark::BaseConfig::~BaseConfig ( )
virtualdefault

◆ BaseConfig() [1/3]

rev::spark::BaseConfig::BaseConfig ( )
protecteddefault

◆ BaseConfig() [2/3]

rev::spark::BaseConfig::BaseConfig ( const BaseConfig )
protecteddelete

◆ BaseConfig() [3/3]

rev::spark::BaseConfig::BaseConfig ( BaseConfig &&  )
protecteddeletenoexcept

Member Function Documentation

◆ Flatten()

std::string BaseConfig::Flatten ( )
virtual

◆ operator=() [1/2]

BaseConfig & rev::spark::BaseConfig::operator= ( const BaseConfig )
protecteddelete

◆ operator=() [2/2]

BaseConfig & rev::spark::BaseConfig::operator= ( BaseConfig &&  )
protecteddeletenoexcept

◆ PutParameter()

template<typename ConfigType >
void rev::spark::BaseConfig::PutParameter ( uint8_t  parameterId,
ConfigType  value 
)
inlineprotected

◆ GetParameter() [1/2]

std::optional< BaseConfig::SparkConfig_t > BaseConfig::GetParameter ( uint8_t  parameterId)
protected

◆ GetParameter() [2/2]

std::optional< BaseConfig::SparkConfig_t > BaseConfig::GetParameter ( BaseConfig fromConfig,
uint8_t  parameterId 
)
protected

◆ RemoveParameter() [1/2]

void rev::spark::BaseConfig::RemoveParameter ( uint8_t  parameterId)
inlineprotected

◆ RemoveParameter() [2/2]

void rev::spark::BaseConfig::RemoveParameter ( BaseConfig fromConfig,
uint8_t  parameterId 
)
inlineprotected

◆ Apply()

void BaseConfig::Apply ( BaseConfig config)
protected

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