valor::swerve::SwerveModule Class Reference

SwerveModule. More...

#include <valkyrie/drivetrain/swerve/SwerveModule.h>

Inheritance diagram for valor::swerve::SwerveModule:

Classes
struct	Config

Public Member Functions
	SwerveModule (Config config, units::meter_t wheelDiameter)
frc::SwerveModuleState	GetState () const
constexpr frc::SwerveModuleState	GetDesiredState () const
frc::SwerveModulePosition	GetPosition () const
units::meters_per_second_t	GetMaxSpeed () const
frc::Translation2d	GetLocation () const
constexpr units::meter_t	GetWheelDiameter () const
void	ApplyRequest (requests::ApplyState)
BaseController &	GetDriveMotor () const
BaseController &	GetAzimuthMotor () const
void	Reset ()
void	LoggablePeriodic () override
	Periodic callback for logging updates.
void	SimulationPeriodic ()
Public Member Functions inherited from valor::Loggable
	Loggable (std::string_view name)
	Construct a Loggable that registers a top-level table name.
	Loggable (std::shared_ptr< nt::NetworkTable > table)
	Construct a Loggable that uses an existing NetworkTable.
	Loggable ()=default
	Default construct an uninitialized Loggable.
void	LogChild (std::string_view name, Loggable *child)
	Register a child Loggable under a named subtree.
void	LogChild (std::string_view name, wpi::Sendable *child)
	Register a child Sendable under a named subtree.
bool	WriteLog (std::string_view field, bool data)
double	WriteLog (std::string_view field, double data)
void	WriteLog (std::string_view field, const std::vector< double > &data)
template<typename U> requires units::traits::is_unit_t_v<U>
U	WriteLog (std::string_view field, U data)
void	WriteLog (std::string_view field, std::string_view data)
template<typename E> requires std::is_enum_v<E>
void	WriteLog (std::string_view field, E data)
template<typename T> requires wpi::StructSerializable<T> && (!std::is_arithmetic_v<T>)
void	WriteLog (std::string_view field, const T &data)
template<typename T> requires wpi::StructSerializable<T> && (!std::is_arithmetic_v<T>)
void	WriteLog (std::string_view field, const std::vector< T > &data)
bool	ReadLog (std::string_view field, bool defaultValue)
double	ReadLog (std::string_view field, double defaultValue)
template<typename U> requires units::traits::is_unit_t_v<U>
U	ReadLog (std::string_view field, U defaultValue)

Additional Inherited Members
Static Public Member Functions inherited from valor::Loggable
static constexpr Loggable &	GetRoot ()
Protected Member Functions inherited from valor::Loggable
virtual void	OnLoggingStart ()
	Hook invoked when logging is started for this object.

Detailed Description

SwerveModule.

Usage:

SwerveModule swerve;

Member Function Documentation

LoggablePeriodic()

void valor::swerve::SwerveModule::LoggablePeriodic ( )

overridevirtual

Periodic callback for logging updates.

If a derived class needs to perform periodic updates to published values, override this method. It is intended to be called by the logging framework; this base class provides an empty implementation.

Reimplemented from valor::Loggable.

---

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

• src/main/include/valkyrie/drivetrain/swerve/SwerveModule.h