$darkmode
Public Member Functions | Protected Attributes | List of all members
cloe::NopWheelSensor Class Reference

#include <wheel_sensor.hpp>

Inheritance diagram for cloe::NopWheelSensor:
[legend]
Collaboration diagram for cloe::NopWheelSensor:
[legend]

Public Member Functions

Wheel wheel_fl () const override
 
Wheel wheel_fr () const override
 
Wheel wheel_rl () const override
 
Wheel wheel_rr () const override
 
void reset () override
 
 WheelSensor ()
 
- Public Member Functions inherited from cloe::WheelSensor
fable::Json active_state () const override
 
 Component (const std::string &name, const std::string &description="")
 
 Component (std::string &&name, std::string &&description="")
 
- Public Member Functions inherited from cloe::Component
 Component (const std::string &name, const std::string &description="")
 
 Component (std::string &&name, std::string &&description="")
 
uint64_t id () const
 
template<typename T >
T * as ()
 
Duration process (const Sync &sync) override
 
void reset () override
 
void abort () override
 
- Public Member Functions inherited from cloe::Model
virtual ~Model () noexcept=default
 
virtual Duration resolution () const
 
virtual bool is_connected () const
 
virtual bool is_operational () const
 
virtual void connect ()
 
virtual void disconnect ()
 
virtual void enroll (Registrar &)
 
virtual void start (const Sync &)
 
virtual void pause (const Sync &)
 
virtual void resume (const Sync &)
 
virtual void stop (const Sync &)
 
 Entity (std::string name)
 
 Entity (std::string name, std::string desc)
 
- Public Member Functions inherited from cloe::Entity
 Entity (std::string name)
 
 Entity (std::string name, std::string desc)
 
const std::string & name () const
 
void set_name (std::string name)
 
const std::string & description () const
 
void set_description (std::string desc)
 

Protected Attributes

Wheel wheel_fl_ {}
 
Wheel wheel_fr_ {}
 
Wheel wheel_rl_ {}
 
Wheel wheel_rr_ {}
 
- Protected Attributes inherited from cloe::Model
bool connected_ {false}
 
bool operational_ {false}
 
- Protected Attributes inherited from cloe::Entity
std::string name_
 
std::string desc_
 

Additional Inherited Members

- Protected Member Functions inherited from cloe::Entity
virtual Logger logger () const
 

Detailed Description

NopWheelSensor is an example no-op implementation of WheelSensor.

Member Function Documentation

◆ reset()

void cloe::NopWheelSensor::reset ( )
inlineoverridevirtual

Reset the model state.

This is called when Cloe is asked to reset the whole simulation to time 0. This can be the case when the simulator or a controller asks us to recover from a temporary problem without repeating the whole simulation setup.

The default implementation will raise an error. So if your model is not able to re-initialize, the simulation will be aborted.

Reimplemented from cloe::Model.

◆ wheel_fl()

Wheel cloe::NopWheelSensor::wheel_fl ( ) const
inlineoverridevirtual

Return front left wheel.

Implements cloe::WheelSensor.

◆ wheel_fr()

Wheel cloe::NopWheelSensor::wheel_fr ( ) const
inlineoverridevirtual

Return front right wheel.

Implements cloe::WheelSensor.

◆ wheel_rl()

Wheel cloe::NopWheelSensor::wheel_rl ( ) const
inlineoverridevirtual

Return rear left wheel.

Implements cloe::WheelSensor.

◆ wheel_rr()

Wheel cloe::NopWheelSensor::wheel_rr ( ) const
inlineoverridevirtual

Return rear right wheel.

Implements cloe::WheelSensor.

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