argos_lib::HomingStorageInterface< T > Class Template Reference

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

#include <homing_interface.h>

Inheritance diagram for argos_lib::HomingStorageInterface< T >:

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

Detailed Description

template<class T>
class argos_lib::HomingStorageInterface< T >

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

Template Parameters

T	Type of the home position. Should be a units type

Member Function Documentation

Load()

template<class T >

virtual std::optional< T > argos_lib::HomingStorageInterface< T >::Load ( )

pure virtual

Load home position from persistent storage.

Returns

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

Implemented in argos_lib::FSHomingStorage< T >, and argos_lib::FSHomingStorage< units::degree_t >.

Save()

template<class T >

virtual bool argos_lib::HomingStorageInterface< T >::Save ( const T &  homePosition )

pure virtual

Save home position to persistent storage.

Parameters

homePosition

Position to store

Returns

true Save successful

false Error saving

Implemented in argos_lib::FSHomingStorage< T >.

---

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

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