EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
ManagerState.hpp File Reference

ManagerState and helpers for the MeasurementManager. More...

#include <ostream>
#include <string>
#include "sensorring/platform/SensorringExport.hpp"
Include dependency graph for ManagerState.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations

enum class  eduart::sensorring::manager::ManagerState {
  Uninitialized , Initialized , Running , Shutdown ,
  Error
}
 Health state of the sensorring state machine worker. More...

Functions

SENSORRING_EXPORT std::string eduart::sensorring::manager::toString (ManagerState state) noexcept
 Function to convert the ManagerState enum class members to string.
SENSORRING_EXPORT std::ostream & eduart::sensorring::manager::operator<< (std::ostream &os, ManagerState state) noexcept
 Output stream operator for the ManagerState enum class members.

Detailed Description

ManagerState and helpers for the MeasurementManager.

Author
EduArt Robotik GmbH
Date
2024-12-25

Enumeration Type Documentation

◆ ManagerState

Health state of the sensorring state machine worker.

Enumerator
Uninitialized 

State machine has not been started yet.

Initialized 

State machine has been configured but not yet running.

Running 

State machine is actively executing measurement cycles.

Shutdown 

State machine has been stopped gracefully.

Error 

State machine encountered an unrecoverable error.

Function Documentation

◆ operator<<()

SENSORRING_EXPORT std::ostream & eduart::sensorring::manager::operator<< ( std::ostream & os,
ManagerState state )
noexcept

Output stream operator for the ManagerState enum class members.

Parameters
[in]osoutput stream to write to
[in]stateto be printed as stream
Returns
Stream of the state's name written out

◆ toString()

SENSORRING_EXPORT std::string eduart::sensorring::manager::toString ( ManagerState state)
noexcept

Function to convert the ManagerState enum class members to string.

Parameters
[in]stateto be converted to a string
Returns
Name of the state written out as string