rev::detached::SignalsConfig Class Reference

#include <DetachedSignalsConfig.h>

Inherits rev::BaseConfig.

Public Member Functions
	SignalsConfig ()=default
	~SignalsConfig () override=default
	SignalsConfig (const SignalsConfig &)=delete
SignalsConfig &	operator= (const SignalsConfig &)=delete
	SignalsConfig (SignalsConfig &&) noexcept=delete
SignalsConfig &	operator= (SignalsConfig &&) noexcept=delete
SignalsConfig &	Apply (SignalsConfig &config)
SignalsConfig &	EncoderPositionPeriodMs (int period_ms)
SignalsConfig &	EncoderVelocityPeriodMs (int period_ms)
SignalsConfig &	EncoderAnglePeriodMs (int period_ms)
Public Member Functions inherited from rev::BaseConfig
virtual	~BaseConfig ()=default
virtual std::string	Flatten ()

Additional Inherited Members
Protected Types inherited from rev::BaseConfig
using	REVLibConfig_t = std::variant< int32_t, uint32_t, float, bool >
Protected Member Functions inherited from rev::BaseConfig
	BaseConfig ()=default
	BaseConfig (const BaseConfig &)=default
BaseConfig &	operator= (const BaseConfig &)=delete
	BaseConfig (BaseConfig &&) noexcept=delete
BaseConfig &	operator= (BaseConfig &&) noexcept=delete
template<typename ConfigType >
void	PutParameter (uint8_t parameterId, ConfigType value)
std::optional< REVLibConfig_t >	GetParameter (uint8_t parameterId)
void	RemoveParameter (uint8_t parameterId)
void	Apply (BaseConfig &config)
Static Protected Member Functions inherited from rev::BaseConfig
static std::optional< REVLibConfig_t >	GetParameter (BaseConfig &fromConfig, uint8_t parameterId)
static void	RemoveParameter (BaseConfig &fromConfig, uint8_t parameterId)

Constructor & Destructor Documentation

SignalsConfig() [1/3]

rev::detached::SignalsConfig::SignalsConfig ( )

default

~SignalsConfig()

rev::detached::SignalsConfig::~SignalsConfig ( )

overridedefault

SignalsConfig() [2/3]

rev::detached::SignalsConfig::SignalsConfig ( const SignalsConfig &  )

delete

SignalsConfig() [3/3]

rev::detached::SignalsConfig::SignalsConfig ( SignalsConfig &&  )

deletenoexcept

Member Function Documentation

operator=() [1/2]

SignalsConfig & rev::detached::SignalsConfig::operator= ( const SignalsConfig &  )

delete

operator=() [2/2]

SignalsConfig & rev::detached::SignalsConfig::operator= ( SignalsConfig &&  )

deletenoexcept

Apply()

SignalsConfig & SignalsConfig::Apply

(

SignalsConfig &

config

)

Applies settings from another SignalsConfig to this one.

Settings in the provided config will overwrite existing values in this object. Settings not specified in the provided config remain unchanged.

Parameters

config

The SignalsConfig to copy settings from

Returns

The updated SignalsConfig for method chaining

EncoderPositionPeriodMs()

SignalsConfig & SignalsConfig::EncoderPositionPeriodMs

(

int

period_ms

)

Set the period (ms) of the status frame that provides the signal returned by DetachedEncoder::GetPosition(). The default period is 50ms.

If multiple periods are set for signals within the same status frame, the minimum given value will be used.

Parameters

periodMs

The period in milliseconds

Returns

The modified SignalsConfig object for method chaining

EncoderVelocityPeriodMs()

SignalsConfig & SignalsConfig::EncoderVelocityPeriodMs

(

int

period_ms

)

Set the period (ms) of the status frame that provides the signal returned by DetachedEncoder::GetVelocity(). The default period is 50ms.

If multiple periods are set for signals within the same status frame, the minimum given value will be used.

Parameters

periodMs

The period in milliseconds

Returns

The modified SignalsConfig object for method chaining

EncoderAnglePeriodMs()

SignalsConfig & SignalsConfig::EncoderAnglePeriodMs

(

int

period_ms

)

Set the period (ms) of the status frame that provides the signal returned by DetachedEncoder::GetAngle(). The default period is 50ms.

If multiple periods are set for signals within the same status frame, the minimum given value will be used.

Parameters

periodMs

The period in milliseconds

Returns

The modified SignalsConfig object for method chaining

---

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

• src/main/native/include/rev/config/DetachedSignalsConfig.h
• src/main/native/cpp/config/DetachedSignalsConfig.cpp