libstp::calibration_store::CalibrationStore Class Reference

Process-wide YAML-backed storage for simple threshold calibrations. More...

#include <CalibrationStore.hpp>

Public Member Functions
	CalibrationStore (const CalibrationStore &)=delete
CalibrationStore &	operator= (const CalibrationStore &)=delete
	CalibrationStore (CalibrationStore &&)=delete
CalibrationStore &	operator= (CalibrationStore &&)=delete
bool	doesFileExist () const
	Check whether the backing YAML file exists.
void	storeReading (float black_tresh, float white_tresh, CalibrationType type, const std::string &set_name="default") const
	Persist one black/white threshold pair for the given calibration type and set.
bool	hasReadings (CalibrationType type, const std::string &set_name="default") const
	Report whether both expected values are present for the given type and set.
std::vector< float >	getReadings (CalibrationType type, const std::string &set_name="default") const
	Return {white_tresh, black_tresh} or {0.0, 0.0} when no reading exists.
std::vector< std::string >	getSetNames (CalibrationType type) const
	Return the names of all calibration sets stored for the given type.

Static Public Member Functions
static CalibrationStore &	instance ()
	Return the singleton store instance.

Detailed Description

Process-wide YAML-backed storage for simple threshold calibrations.

Definition at line 17 of file CalibrationStore.hpp.

Constructor & Destructor Documentation

CalibrationStore() [1/2]

libstp::calibration_store::CalibrationStore::CalibrationStore ( const CalibrationStore & )

delete

CalibrationStore() [2/2]

libstp::calibration_store::CalibrationStore::CalibrationStore ( CalibrationStore && )

delete

Member Function Documentation

doesFileExist()

bool libstp::calibration_store::CalibrationStore::doesFileExist ( ) const

nodiscard

Check whether the backing YAML file exists.

getReadings()

std::vector< float > libstp::calibration_store::CalibrationStore::getReadings ( CalibrationType type, const std::string & set_name = "default" ) const

nodiscard

Return {white_tresh, black_tresh} or {0.0, 0.0} when no reading exists.

getSetNames()

std::vector< std::string > libstp::calibration_store::CalibrationStore::getSetNames ( CalibrationType type ) const

nodiscard

Return the names of all calibration sets stored for the given type.

hasReadings()

bool libstp::calibration_store::CalibrationStore::hasReadings ( CalibrationType type, const std::string & set_name = "default" ) const

nodiscard

Report whether both expected values are present for the given type and set.

instance()

CalibrationStore & libstp::calibration_store::CalibrationStore::instance ( )

static

Return the singleton store instance.

operator=() [1/2]

CalibrationStore & libstp::calibration_store::CalibrationStore::operator= ( CalibrationStore && )

delete

operator=() [2/2]

CalibrationStore & libstp::calibration_store::CalibrationStore::operator= ( const CalibrationStore & )

delete

storeReading()

void libstp::calibration_store::CalibrationStore::storeReading	(	float	black_tresh,
		float	white_tresh,
		CalibrationType	type,
		const std::string &	set_name = "default" ) const

Persist one black/white threshold pair for the given calibration type and set.

---

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

• /home/runner/work/raccoon-lib/raccoon-lib/modules/libstp-calibration-store/include/CalibrationStore.hpp