logger.hpp File Reference

A Logger for LemLib. More...

Go to the source code of this file.

Enumerations
enum class	lemlib::logger::Level {   DEBUG , INFO , WARN , ERROR ,   FATAL }
	A level enumeration. More...

Functions
bool	lemlib::logger::isDebug ()
	Whether or not to log debug messages. More...
void	lemlib::logger::setDebug (bool debug)
	Sets lemlib::debug. More...
bool	lemlib::logger::isVerbose ()
	Whether or not to log info messages. More...
void	lemlib::logger::setVerbose (bool verbose)
	Sets lemlib::verbose. More...
Level	lemlib::logger::getLowestLevel ()
	The current lowest log level. More...
void	lemlib::logger::setLowestLevel (Level level)
	Sets the lowest loggable level. More...
void	lemlib::logger::log (Level level, const char *message, const char *exception)
	Logs a message with an exception. More...
void	lemlib::logger::log (Level level, const char *message)
	Logs a message. More...
void	lemlib::logger::debug (const char *message)
	Logs a debug message. More...
void	lemlib::logger::info (const char *message)
	Logs an info message. More...
void	lemlib::logger::warn (const char *message)
	Logs a warning message. More...
void	lemlib::logger::error (const char *message, const char *exception)
	Logs an error message. More...
void	lemlib::logger::error (const char *message)
	Logs an error message. More...
void	lemlib::logger::fatal (const char *message, const char *exception)
	Logs a fatal message. More...
void	lemlib::logger::fatal (const char *message)
	Logs a fatal message. More...

Detailed Description

A Logger for LemLib.

Author

LemLib Team

Version

0.4.5

Date

2023-02-12

Copyright

Copyright (c) 2023

Enumeration Type Documentation

Level

enum class lemlib::logger::Level

strong

A level enumeration.

Debug: Only enabled if lemlib::logger::debug is true Info: General information Warn: Warnings, usually not critical/doesn't affect the robot Error: Errors, usually critical and affects the robot Fatal: Fatal errors, crashes the program

Note

The log level is inclusive. For example, if the log level is set to

Function Documentation

debug()

void lemlib::logger::debug

(

const char *

message

)

Logs a debug message.

Parameters

message

error() [1/2]

void lemlib::logger::error

(

const char *

message

)

Logs an error message.

Parameters

message

error() [2/2]

void lemlib::logger::error	(	const char *	message,
		const char *	exception
	)

Logs an error message.

Parameters

message
exception

fatal() [1/2]

void lemlib::logger::fatal

(

const char *

message

)

Logs a fatal message.

Parameters

message

fatal() [2/2]

void lemlib::logger::fatal	(	const char *	message,
		const char *	exception
	)

Logs a fatal message.

Parameters

message
exception

getLowestLevel()

Level lemlib::logger::getLowestLevel

(

)

The current lowest log level.

Returns

the lowest loggable level

info()

void lemlib::logger::info

(

const char *

message

)

Logs an info message.

Parameters

message

isDebug()

bool lemlib::logger::isDebug

(

)

Whether or not to log debug messages.

Returns

true if debug is enabled

isVerbose()

bool lemlib::logger::isVerbose

(

)

Whether or not to log info messages.

If false, only log messages with a level of lemlib::logger::Level::WARN or higher will be logged

log() [1/2]

void lemlib::logger::log	(	Level	level,
		const char *	message
	)

Logs a message.

Parameters

level	the level of the message
message	the message

log() [2/2]

void lemlib::logger::log	(	Level	level,
		const char *	message,
		const char *	exception
	)

Logs a message with an exception.

Parameters

level	the level of the message
message	the message
exception	the exception

setDebug()

void lemlib::logger::setDebug

(

bool

debug

)

Sets lemlib::debug.

Parameters

debug

the new value

setLowestLevel()

void lemlib::logger::setLowestLevel

(

Level

level

)

Sets the lowest loggable level.

Parameters

level

the new lowest loggable level

setVerbose()

void lemlib::logger::setVerbose

(

bool

verbose

)

Sets lemlib::verbose.

Parameters

verbose

the new value

warn()

void lemlib::logger::warn

(

const char *

message

)

Logs a warning message.

Parameters

message