okapi::VelMathFactory class
#include <include/okapi/impl/filter/velMathFactory.hpp>

Contents

Public static functions

static auto create(double iticksPerRev, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger()) -> VelMath
Velocity math helper.
static auto createPtr(double iticksPerRev, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger()) -> std::unique_ptr<VelMath>
Velocity math helper.
static auto create(double iticksPerRev, std::unique_ptr<Filter> ifilter, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger()) -> VelMath
Velocity math helper.
static auto createPtr(double iticksPerRev, std::unique_ptr<Filter> ifilter, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger()) -> std::unique_ptr<VelMath>
Velocity math helper.

Function documentation

static VelMath okapi::VelMathFactory::create(double iticksPerRev, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger())

Velocity math helper.

Parameters
iticksPerRev The number of ticks per revolution.
isampleTime The minimum time between samples.
ilogger The logger this instance will log to.

Calculates filtered velocity. Throws a std::invalid_argument exception if iticksPerRev is zero. Averages the last two readings.

static std::unique_ptr<VelMath> okapi::VelMathFactory::createPtr(double iticksPerRev, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger())

Velocity math helper.

Parameters
iticksPerRev The number of ticks per revolution.
isampleTime The minimum time between samples.
ilogger The logger this instance will log to.

Calculates filtered velocity. Throws a std::invalid_argument exception if iticksPerRev is zero. Averages the last two readings.

static VelMath okapi::VelMathFactory::create(double iticksPerRev, std::unique_ptr<Filter> ifilter, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger())

Velocity math helper.

Parameters
iticksPerRev The number of ticks per revolution.
ifilter The filter used for filtering the calculated velocity.
isampleTime The minimum time between samples.
ilogger The logger this instance will log to.

Calculates filtered velocity. Throws a std::invalid_argument exception if iticksPerRev is zero.

static std::unique_ptr<VelMath> okapi::VelMathFactory::createPtr(double iticksPerRev, std::unique_ptr<Filter> ifilter, QTime isampleTime = 0_ms, const std::shared_ptr<Logger>& ilogger = Logger::getDefaultLogger())

Velocity math helper.

Parameters
iticksPerRev The number of ticks per revolution.
ifilter The filter used for filtering the calculated velocity.
isampleTime The minimum time between samples.
ilogger The logger this instance will log to.

Calculates filtered velocity. Throws a std::invalid_argument exception if iticksPerRev is zero.