argos_lib::SwerveHomeStorageInterface Class Reference

Interface capable of saving and loading module home positions from persistent storage. More...

#include <homing_interface.h>

Inheritance diagram for argos_lib::SwerveHomeStorageInterface:

Public Member Functions
virtual bool	Save (const argos_lib::swerve::SwerveModulePositions &homePosition)=0
	Save home position to persistent storage.
virtual std::optional< argos_lib::swerve::SwerveModulePositions >	Load ()=0
	Load home position from persistent storage.

Detailed Description

Interface capable of saving and loading module home positions from persistent storage.

Member Function Documentation

Load()

virtual std::optional< argos_lib::swerve::SwerveModulePositions > argos_lib::SwerveHomeStorageInterface::Load ( )

pure virtual

Load home position from persistent storage.

Returns

Poisitions from persistent storage or std::nullopt if load failed or no positions were previously stored

Implemented in argos_lib::SwerveFSHomingStorage, and argos_lib::swerve::NetworkTablesHomingStorage.

Save()

virtual bool argos_lib::SwerveHomeStorageInterface::Save ( const argos_lib::swerve::SwerveModulePositions &  homePosition )

pure virtual

Save home position to persistent storage.

Parameters

homePosition

Positions to store

Returns

true Save successful

false Error saving

Implemented in argos_lib::SwerveFSHomingStorage, and argos_lib::swerve::NetworkTablesHomingStorage.

---

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

• src/argos_lib/include/argos_lib/homing/homing_interface.h