agroeye::general Namespace Reference

Namespaces
	geometry

Typedefs
using	ListCallbackTypes = std::vector< CallbackTypes >
using	CallbackFunction = std::function< void(double, ListCallbackTypes, std::string)>

Enumerations
enum	CallbackTypes { CallbackTypes::PROGRESS, CallbackTypes::INFO, CallbackTypes::DEBUG, CallbackTypes::ERROR }
	Type of callback that can be called function. More...

Functions
void	defaultCallback (double progress, ListCallbackTypes listTypes, std::string message)
	A default callback. More...
void	silenceCallback (double progress, ListCallbackTypes listTypes, std::string message)
	Silencing callback. More...

Typedef Documentation

CallbackFunction

using agroeye::general::CallbackFunction = typedef std::function<void(double, ListCallbackTypes, std::string)>

Typedef for callback function

ListCallbackTypes

using agroeye::general::ListCallbackTypes = typedef std::vector<CallbackTypes>

List containg types of callback types when function is called

Enumeration Type Documentation

CallbackTypes

enum agroeye::general::CallbackTypes

strong

Type of callback that can be called function.

Enumerator
PROGRESS	contains inforamtion about progress of process
INFO	contains message
DEBUG	debugging information
ERROR	process encountered an error

Function Documentation

defaultCallback()

void agroeye::general::defaultCallback	(	double	progress,
		ListCallbackTypes	listTypes,
		std::string	message
	)

A default callback.

When this function is called the list of callback types is checked.

• If it has INFO type the message is printed in the stdcout.
• If it has PROGRESS type the messege is printed with associated progress value in percentage
• In all other cases there is no printout

silenceCallback()

void agroeye::general::silenceCallback	(	double	progress,
		ListCallbackTypes	listTypes,
		std::string	message
	)

Silencing callback.

All information passed to this callback are silenced (not displayed or processed in any way)

Here is the caller graph for this function: