upkie::cpp::observers::BaseOrientation Class Reference

Observe the orientation of the base frame relative to the world frame. More...

#include <BaseOrientation.h>

Classes
struct	Parameters
	Parameters for the base orientation observer. More...

Public Member Functions
	BaseOrientation (const Parameters &params)
	Initialize observer. More...
std::string	prefix () const noexcept final
	Prefix of outputs in the observation dictionary. More...
void	reset (const Dictionary &config) override
	Reset observer. More...
void	read (const Dictionary &observation) final
	Read inputs from other observations. More...
void	write (Dictionary &observation) final
	Write outputs, called if reading was successful. More...
Public Member Functions inherited from upkie::cpp::observers::Observer
virtual	~Observer ()
	Destructor is virtual to deallocate lists of observers properly.
virtual std::string	prefix () const noexcept
	Prefix of outputs in the observation dictionary. More...
virtual void	reset (const Dictionary &config)
	Reset observer. More...
virtual void	read (const Dictionary &observation)
	Read inputs from other observations. More...
virtual void	write (Dictionary &observation)
	Write outputs, called if reading was successful. More...

Detailed Description

Observe the orientation of the base frame relative to the world frame.

Constructor & Destructor Documentation

BaseOrientation()

upkie::cpp::observers::BaseOrientation::BaseOrientation ( const Parameters &  params )

explicit

Initialize observer.

Parameters

[in]

params

Observer parameters.

Member Function Documentation

prefix()

std::string upkie::cpp::observers::BaseOrientation::prefix ( ) const

inlinefinalvirtualnoexcept

Prefix of outputs in the observation dictionary.

Reimplemented from upkie::cpp::observers::Observer.

read()

void upkie::cpp::observers::BaseOrientation::read ( const Dictionary &  observation )

finalvirtual

Read inputs from other observations.

Parameters

[in]

observation

Dictionary to read other observations from.

Reimplemented from upkie::cpp::observers::Observer.

reset()

void upkie::cpp::observers::BaseOrientation::reset ( const Dictionary &  config )

overridevirtual

Reset observer.

Parameters

[in]

config

Overall configuration dictionary.

Reimplemented from upkie::cpp::observers::Observer.

write()

void upkie::cpp::observers::BaseOrientation::write ( Dictionary &  observation )

finalvirtual

Write outputs, called if reading was successful.

Parameters

[out]

observation

Dictionary to write observations to.

Reimplemented from upkie::cpp::observers::Observer.

---

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

• upkie/cpp/observers/BaseOrientation.h
• upkie/cpp/observers/BaseOrientation.cpp