steppable::output Namespace Reference

Message-printing utilities for Steppable. More...

Functions
template<typename T>
void	error (const std::string &name, const std::basic_string< T > &msg, const std::vector< std::string > &args={})
	Prints an error message.
template<typename T>
void	warning (const std::basic_string< T > &name, const std::basic_string< T > &msg, const std::vector< std::string > &args={})
	Prints a warning message.
template<typename T>
void	info (const std::basic_string< T > &name, const std::basic_string< T > &msg, const std::vector< std::string > &args={})
	Prints an info message.

Detailed Description

Message-printing utilities for Steppable.

Function Documentation

error()

template<typename T>

void steppable::output::error	(	const std::string &	name,
		const std::basic_string< T > &	msg,
		const std::vector< std::string > &	args = {} )

Prints an error message.

This function prints an error message with the given name and message. Additional arguments can be provided to format the message using the std::basic_string<T> format syntax.

The message is printed in red color, and is also written to the log file. It is intended to tell the user that something is going wrong and cannot be handled.

Template Parameters

T	The character type of the message.

Parameters

[in]	name	The name of the error.
[in]	msg	The error message.
[in]	args	Additional arguments for formatting the message.

Here is the caller graph for this function:

info()

template<typename T>

void steppable::output::info	(	const std::basic_string< T > &	name,
		const std::basic_string< T > &	msg,
		const std::vector< std::string > &	args = {} )

Prints an info message.

This function prints an info message with the given name and message. Additional arguments can be provided to format the message using the std::basic_string<T> format syntax.

The message is printed in bright green color. It is intended to tell the user that something is going right, or to provide some information.

Template Parameters

T	The character type of the message.

Parameters

[in]	name	The name of the info message.
[in]	msg	The info message.
[in]	args	Additional arguments for formatting the message.

Here is the caller graph for this function:

warning()

template<typename T>

void steppable::output::warning	(	const std::basic_string< T > &	name,
		const std::basic_string< T > &	msg,
		const std::vector< std::string > &	args = {} )

Prints a warning message.

This function prints an error message with the given name and message. Additional arguments can be provided to format the message using the std::basic_string<T> format syntax.

The message is printed in yellow color, and is also written to the log file. It is intended to tell the user that something is going wrong but can be handled.

Template Parameters

T	The character type of the message.

Parameters

[in]	name	The name of the warning
[in]	msg	The error message.
[in]	args	Additional arguments for formatting the message.

Here is the caller graph for this function: