REVLib - C++
rev::BaseConfig Class Reference

#include <BaseConfig.h>

Inheritance diagram for rev::BaseConfig:
rev::detached::DetachedEncoderConfig rev::detached::SignalsConfig rev::servohub::ServoChannelConfig rev::servohub::ServoHubConfig rev::spark::AbsoluteEncoderConfig rev::spark::AlternateEncoderConfig rev::spark::AnalogSensorConfig rev::spark::ClosedLoopConfig rev::spark::EncoderConfig rev::spark::ExternalEncoderConfig rev::spark::FeedForwardConfig rev::spark::LimitSwitchConfig rev::spark::MAXMotionConfig rev::spark::SignalsConfig rev::spark::SoftLimitConfig rev::spark::SparkBaseConfig

Public Member Functions

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

Protected Types

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

Protected Member Functions

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

Static Protected Member Functions

static std::optional< ParameterType_tGetParameter (BaseConfig &fromConfig, uint8_t parameterId)
 
static void RemoveParameter (BaseConfig &fromConfig, uint8_t parameterId)
 

Member Typedef Documentation

◆ ParameterType_t

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

Constructor & Destructor Documentation

◆ ~BaseConfig()

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

◆ BaseConfig() [1/3]

rev::BaseConfig::BaseConfig ( )
protecteddefault

◆ BaseConfig() [2/3]

rev::BaseConfig::BaseConfig ( const BaseConfig )
protecteddefault

◆ BaseConfig() [3/3]

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

Member Function Documentation

◆ Flatten()

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ PutParameter()

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

◆ GetParameter() [1/2]

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

◆ GetParameter() [2/2]

std::optional< BaseConfig::ParameterType_t > BaseConfig::GetParameter ( BaseConfig fromConfig,
uint8_t  parameterId 
)
staticprotected

◆ RemoveParameter() [1/2]

void BaseConfig::RemoveParameter ( uint8_t  parameterId)
protected

◆ RemoveParameter() [2/2]

void BaseConfig::RemoveParameter ( BaseConfig fromConfig,
uint8_t  parameterId 
)
staticprotected

◆ Apply()

void BaseConfig::Apply ( BaseConfig config)
protected

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