Classes
class	Logger
	Logger used to log messages with different verbosity levels Can be used to redirect log messages to custom outputs by setting a callback. More...

struct	LogRecord
	Structure to hold a log record Used by the Logger class. More...

class	TicToc

Enumerations
enum	TT_ATTIBUTES { TT_RESET = 0 , TT_BRIGHT = 1 , TT_DIM = 2 , TT_UNDERLINE = 3 , TT_BLINK = 4 , TT_REVERSE = 7 , TT_HIDDEN = 8 }

enum	TT_COLORS { TT_BLACK , TT_RED , TT_GREEN , TT_YELLOW , TT_BLUE , TT_MAGENTA , TT_CYAN , TT_WHITE }

enum	VERBOSITY_LEVEL { L_ALWAYS , L_ERROR , L_WARN , L_INFO , L_DEBUG , L_VERBOSE }

Functions
PCL_EXPORTS bool	find_switch (int argc, const char const argv, const char *argument_name)
	Finds whether the argument with name "argument_name" is in the argument list "argv".

PCL_EXPORTS int	find_argument (int argc, const char const argv, const char *argument_name)
	Finds the position of the argument with name "argument_name" in the argument list "argv".

template<typename Type >
int	parse (int argc, const char const argv, const char *argument_name, Type &value)
	Template version for parsing arguments.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, std::string &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, bool &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, float &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, double &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, int &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, unsigned int &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, long int &val) noexcept
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_argument (int argc, const char const argv, const char *str, char &val)
	Parse for a specific given command line argument.

PCL_EXPORTS int	parse_2x_arguments (int argc, const char const argv, const char *str, float &f, float &s, bool debug=true)
	Parse for specific given command line arguments (2x values comma separated).

PCL_EXPORTS int	parse_2x_arguments (int argc, const char const argv, const char *str, double &f, double &s, bool debug=true)
	Parse for specific given command line arguments (2x values comma separated).

PCL_EXPORTS int	parse_2x_arguments (int argc, const char const argv, const char *str, int &f, int &s, bool debug=true)
	Parse for specific given command line arguments (2x values comma separated).

PCL_EXPORTS int	parse_3x_arguments (int argc, const char const argv, const char *str, float &f, float &s, float &t, bool debug=true)
	Parse for specific given command line arguments (3x values comma separated).

PCL_EXPORTS int	parse_3x_arguments (int argc, const char const argv, const char *str, double &f, double &s, double &t, bool debug=true)
	Parse for specific given command line arguments (3x values comma separated).

PCL_EXPORTS int	parse_3x_arguments (int argc, const char const argv, const char *str, int &f, int &s, int &t, bool debug=true)
	Parse for specific given command line arguments (3x values comma separated).

PCL_EXPORTS int	parse_x_arguments (int argc, const char const argv, const char *str, std::vector< double > &v)
	Parse for specific given command line arguments (3x values comma separated).

PCL_EXPORTS int	parse_x_arguments (int argc, const char const argv, const char *str, std::vector< float > &v)
	Parse for specific given command line arguments (N values comma separated).

PCL_EXPORTS int	parse_x_arguments (int argc, const char const argv, const char *str, std::vector< int > &v)
	Parse for specific given command line arguments (N values comma separated).

PCL_EXPORTS bool	parse_multiple_arguments (int argc, const char const argv, const char *str, std::vector< int > &values)
	Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

PCL_EXPORTS bool	parse_multiple_arguments (int argc, const char const argv, const char *str, std::vector< float > &values)
	Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

PCL_EXPORTS bool	parse_multiple_arguments (int argc, const char const argv, const char *str, std::vector< double > &values)
	Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

PCL_EXPORTS bool	parse_multiple_arguments (int argc, const char const argv, const char *str, std::vector< std::string > &values)
	Parse for a specific given command line argument (multiple occurrences of the same command line parameter).

PCL_EXPORTS bool	parse_multiple_2x_arguments (int argc, const char const argv, const char *str, std::vector< double > &values_f, std::vector< double > &values_s)
	Parse command line arguments for file names with given extension (multiple occurrences of 2x argument groups, separated by commas).

PCL_EXPORTS bool	parse_multiple_3x_arguments (int argc, const char const argv, const char *str, std::vector< double > &values_f, std::vector< double > &values_s, std::vector< double > &values_t)
	Parse command line arguments for file names with given extension (multiple occurrences of 3x argument groups, separated by commas).

PCL_EXPORTS std::vector< int >	parse_file_extension_argument (int argc, const char const argv, const std::vector< std::string > &extensions)
	Parse command line arguments for file names with given extension vector.

PCL_EXPORTS std::vector< int >	parse_file_extension_argument (int argc, const char const argv, const std::string &ext)
	Parse command line arguments for file names with given extension.

PCL_EXPORTS void	setVerbosityLevel (VERBOSITY_LEVEL level)
	set the verbosity level

PCL_EXPORTS VERBOSITY_LEVEL	getVerbosityLevel ()
	get the verbosity level.

PCL_EXPORTS bool	initVerbosityLevel ()
	initialize verbosity level.

PCL_EXPORTS bool	isVerbosityLevelEnabled (VERBOSITY_LEVEL severity)
	is verbosity level enabled?

PCL_EXPORTS void	enableColoredOutput (FILE *stream, bool enable)
	Enable or disable colored text output, overriding the default behavior.

PCL_EXPORTS void	change_text_color (FILE *stream, int attribute, int fg, int bg)
	Change the text color (on either stdout or stderr) with an attr:fg:bg.

PCL_EXPORTS void	change_text_color (FILE *stream, int attribute, int fg)
	Change the text color (on either stdout or stderr) with an attr:fg.

PCL_EXPORTS void	reset_text_color (FILE *stream)
	Reset the text color (on either stdout or stderr) to its original state.

template<typename Functor >
void	setCallback (Functor &&callback)
	Sets a callable in the Logger instance, which is called whenever a printout has occured.

template<typename... Args>
std::string	to_string (const std::string fmt_str,...)
	insert values into a formatted string

template<typename... Args>
PCL_EXPORTS void	print_info (FILE *stream, const std::string format, Args &&... args)
	Print an info message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_info (const std::string format, Args &&... args)
	Print an info message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_error (FILE *stream, const std::string format, Args &&... args)
	Print an error message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_error (std::string format, Args &&... args)
	Print an error message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_warn (FILE *stream, const std::string format, Args &&... args)
	Print a warning message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_warn (std::string format, Args &&... args)
	Print a warning message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_debug (FILE *stream, const std::string format, Args &&... args)
	Print a debug message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_debug (const std::string format, Args &&... args)
	Print a debug message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_color (FILE *stream, int attr, int fg, const std::string format, Args &&... args)
	Print a message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_value (FILE *stream, const std::string format, Args &&... args)
	Print a value message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_value (const std::string format, Args &&... args)
	Print a value message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print (VERBOSITY_LEVEL level, FILE *stream, const std::string format, Args &&...args)
	Print a message on stream.

template<typename... Args>
void	print (VERBOSITY_LEVEL level, const std::string format, Args &&... args)
	Print a message.

template<typename... Args>
PCL_EXPORTS void	print_highlight (FILE *stream, const std::string format, Args... args)
	Print a highlighted info message on stream with colors.

template<typename... Args>
PCL_EXPORTS void	print_highlight (const std::string format, Args &&...args)
	Print a highlighted info message on stream with colors.

Enumeration Type Documentation

◆ TT_ATTIBUTES

enum pcl::console::TT_ATTIBUTES

Enumerator
TT_RESET
TT_BRIGHT
TT_DIM
TT_UNDERLINE
TT_BLINK
TT_REVERSE
TT_HIDDEN

Definition at line 102 of file print.h.

◆ TT_COLORS

enum pcl::console::TT_COLORS

Enumerator
TT_BLACK
TT_RED
TT_GREEN
TT_YELLOW
TT_BLUE
TT_MAGENTA
TT_CYAN
TT_WHITE

Definition at line 113 of file print.h.

◆ VERBOSITY_LEVEL

enum pcl::console::VERBOSITY_LEVEL

Enumerator
L_ALWAYS
L_ERROR
L_WARN
L_INFO
L_DEBUG
L_VERBOSE

Definition at line 125 of file print.h.

Function Documentation

◆ change_text_color() [1/2]

PCL_EXPORTS void pcl::console::change_text_color	(	FILE *	stream,
		int	attribute,
		int	fg
	)

Change the text color (on either stdout or stderr) with an attr:fg.

Parameters

stream	the output stream (stdout, stderr, etc)
attribute	the text attribute
fg	the foreground color

◆ change_text_color() [2/2]

PCL_EXPORTS void pcl::console::change_text_color	(	FILE *	stream,
		int	attribute,
		int	fg,
		int	bg
	)

Change the text color (on either stdout or stderr) with an attr:fg:bg.

Parameters

stream	the output stream (stdout, stderr, etc)
attribute	the text attribute
fg	the foreground color
bg	the background color

◆ enableColoredOutput()

PCL_EXPORTS void pcl::console::enableColoredOutput	(	FILE *	stream,
		bool	enable
	)

Enable or disable colored text output, overriding the default behavior.

By default, colored output is enabled for interactive terminals or when the environment variable PCL_CLICOLOR_FORCE is set.

Parameters

stream	the output stream (stdout, stderr, etc)
enable	whether to emit color codes when calling any of the color related methods

◆ find_argument()

PCL_EXPORTS int pcl::console::find_argument	(	int	argc,
		const char const	argv,
		const char *	argument_name
	)

Finds the position of the argument with name "argument_name" in the argument list "argv".

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	argument_name	the string value to search for

Returns: index of found argument or -1 if arguments do not appear in list

Referenced by parse().

◆ find_switch()

PCL_EXPORTS bool pcl::console::find_switch	(	int	argc,
		const char const	argv,
		const char *	argument_name
	)

Finds whether the argument with name "argument_name" is in the argument list "argv".

An example for a widely used switch argument is the "-r" flag for unix commands that indicates whether the command should run recursively or not.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	argument_name	the string value to search for

Returns: true if argument was found, false otherwise

Note: find_switch is simply returning find_argument != -1.

◆ getVerbosityLevel()

PCL_EXPORTS VERBOSITY_LEVEL pcl::console::getVerbosityLevel ( )

get the verbosity level.

◆ initVerbosityLevel()

PCL_EXPORTS bool pcl::console::initVerbosityLevel ( )

initialize verbosity level.

◆ isVerbosityLevelEnabled()

PCL_EXPORTS bool pcl::console::isVerbosityLevelEnabled ( VERBOSITY_LEVEL severity )

is verbosity level enabled?

Referenced by pcl::registration::TransformationEstimationPointToPlaneLLS< PointSource, PointTarget, Scalar >::estimateRigidTransformation(), pcl::registration::TransformationEstimationSVD< PointSource, PointTarget, Scalar >::getTransformationFromCorrelation(), pcl::ConvexHull< PointInT >::performReconstruction2D(), pcl::ConvexHull< PointInT >::performReconstruction3D(), print(), and print().

◆ parse()

template<typename Type >

int pcl::console::parse	(	int	argc,
		const char const	argv,
		const char *	argument_name,
		Type &	value
	)

Template version for parsing arguments.

Template parameter needs to have input stream operator overloaded!

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	argument_name	the name of the argument to search for
[out]	value	The value of the argument

Returns: index of found argument or -1 if arguments do not appear in list

Definition at line 78 of file parse.h.

References find_argument().

◆ parse_2x_arguments() [1/3]

PCL_EXPORTS int pcl::console::parse_2x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		double &	f,
		double &	s,
		bool	debug = `true`
	)

Parse for specific given command line arguments (2x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[in]	debug	whether to print debug info or not

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_2x_arguments() [2/3]

PCL_EXPORTS int pcl::console::parse_2x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		float &	f,
		float &	s,
		bool	debug = `true`
	)

Parse for specific given command line arguments (2x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[in]	debug	whether to print debug info or not

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_2x_arguments() [3/3]

PCL_EXPORTS int pcl::console::parse_2x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		int &	f,
		int &	s,
		bool	debug = `true`
	)

Parse for specific given command line arguments (2x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[in]	debug	whether to print debug info or not

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_3x_arguments() [1/3]

PCL_EXPORTS int pcl::console::parse_3x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		double &	f,
		double &	s,
		double &	t,
		bool	debug = `true`
	)

Parse for specific given command line arguments (3x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[out]	t	the third output value
[in]	debug	whether to print debug info or not

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_3x_arguments() [2/3]

PCL_EXPORTS int pcl::console::parse_3x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		float &	f,
		float &	s,
		float &	t,
		bool	debug = `true`
	)

Parse for specific given command line arguments (3x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[out]	t	the third output value
[in]	debug	whether to print debug info or not

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_3x_arguments() [3/3]

PCL_EXPORTS int pcl::console::parse_3x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		int &	f,
		int &	s,
		int &	t,
		bool	debug = `true`
	)

Parse for specific given command line arguments (3x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	f	the first output value
[out]	s	the second output value
[out]	t	the third output value
[in]	debug	whether to print debug info or not return index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [1/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		bool &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [2/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		char &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [3/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		double &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [4/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		float &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [5/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		int &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [6/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		long int &	val
	)

noexcept

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [7/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		std::string &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_argument() [8/8]

PCL_EXPORTS int pcl::console::parse_argument	(	int	argc,
		const char const	argv,
		const char *	str,
		unsigned int &	val
	)

Parse for a specific given command line argument.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	val	the resultant value

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_file_extension_argument() [1/2]

PCL_EXPORTS std::vector< int > pcl::console::parse_file_extension_argument	(	int	argc,
		const char const	argv,
		const std::string &	ext
	)

Parse command line arguments for file names with given extension.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	ext	the extension to search for

Returns: a vector with file names indices

◆ parse_file_extension_argument() [2/2]

PCL_EXPORTS std::vector< int > pcl::console::parse_file_extension_argument	(	int	argc,
		const char const	argv,
		const std::vector< std::string > &	extensions
	)

Parse command line arguments for file names with given extension vector.

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	extensions	the extensions to search for

Returns: a vector with file names indices

◆ parse_multiple_2x_arguments()

PCL_EXPORTS bool pcl::console::parse_multiple_2x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< double > &	values_f,
		std::vector< double > &	values_s
	)

Parse command line arguments for file names with given extension (multiple occurrences of 2x argument groups, separated by commas).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	values_f	the first vector of output values
[out]	values_s	the second vector of output values

Returns: true if found, false otherwise

◆ parse_multiple_3x_arguments()

PCL_EXPORTS bool pcl::console::parse_multiple_3x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< double > &	values_f,
		std::vector< double > &	values_s,
		std::vector< double > &	values_t
	)

Parse command line arguments for file names with given extension (multiple occurrences of 3x argument groups, separated by commas).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	values_f	the first vector of output values
[out]	values_s	the second vector of output values
[out]	values_t	the third vector of output values

Returns: true if found, false otherwise

◆ parse_multiple_arguments() [1/4]

PCL_EXPORTS bool pcl::console::parse_multiple_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< double > &	values
	)

Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	values	the resultant output values

Returns: true if found, false otherwise

◆ parse_multiple_arguments() [2/4]

PCL_EXPORTS bool pcl::console::parse_multiple_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< float > &	values
	)

Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	values	the resultant output values

Returns: true if found, false otherwise

◆ parse_multiple_arguments() [3/4]

PCL_EXPORTS bool pcl::console::parse_multiple_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< int > &	values
	)

Parse for specific given command line arguments (multiple occurrences of the same command line parameter).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	values	the resultant output values

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_multiple_arguments() [4/4]

PCL_EXPORTS bool pcl::console::parse_multiple_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< std::string > &	values
	)

Parse for a specific given command line argument (multiple occurrences of the same command line parameter).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the string value to search for
[out]	values	the resultant output values

Returns: true if found, false otherwise

◆ parse_x_arguments() [1/3]

PCL_EXPORTS int pcl::console::parse_x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< double > &	v
	)

Parse for specific given command line arguments (3x values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	v	the vector into which the parsed values will be copied

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_x_arguments() [2/3]

PCL_EXPORTS int pcl::console::parse_x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< float > &	v
	)

Parse for specific given command line arguments (N values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	v	the vector into which the parsed values will be copied

Returns: index of found argument or -1 if arguments do not appear in list

◆ parse_x_arguments() [3/3]

PCL_EXPORTS int pcl::console::parse_x_arguments	(	int	argc,
		const char const	argv,
		const char *	str,
		std::vector< int > &	v
	)

Parse for specific given command line arguments (N values comma separated).

Parameters

[in]	argc	the number of command line arguments
[in]	argv	the command line arguments
[in]	str	the command line argument to search for
[out]	v	the vector into which the parsed values will be copied

Returns: index of found argument or -1 if arguments do not appear in list

◆ print() [1/2]

template<typename... Args>

void pcl::console::print	(	VERBOSITY_LEVEL	level,
		const std::string	format,
		Args &&...	args
	)

Print a message.

Parameters

level	Verbosity level
fmt_str	the string containing the formatting
...args	values to be inserted into the fmt_str

Definition at line 433 of file print.h.

References pcl::console::Logger::getInstance(), isVerbosityLevelEnabled(), pcl::console::Logger::print(), and to_string().

◆ print() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print	(	VERBOSITY_LEVEL	level,
		FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print a message on stream.

Parameters

level	the verbosity level
stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 415 of file print.h.

References pcl::console::Logger::getInstance(), isVerbosityLevelEnabled(), pcl::console::Logger::print(), and to_string().

Referenced by print_debug(), print_error(), print_info(), and print_warn().

◆ print_color()

template<typename... Args>

PCL_EXPORTS void pcl::console::print_color	(	FILE *	stream,
		int	attr,
		int	fg,
		const std::string	format,
		Args &&...	args
	)

Print a message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
attr	the text attribute
fg	the foreground color
format	the message

Definition at line 378 of file print.h.

References pcl::console::Logger::getInstance(), L_ALWAYS, pcl::console::Logger::print_color(), and to_string().

◆ print_debug() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_debug	(	const std::string	format,
		Args &&...	args
	)

Print a debug message on stream with colors.

Parameters

format the message

Definition at line 365 of file print.h.

References print_debug().

◆ print_debug() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_debug	(	FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print a debug message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 355 of file print.h.

References L_DEBUG, and print().

Referenced by print_debug().

◆ print_error() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_error	(	FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print an error message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 313 of file print.h.

References L_ERROR, and print().

Referenced by pcl::visualization::PCLVisualizer::addPointCloudPrincipalCurvatures(), pcl::TSDFVolume< VoxelT, WeightT >::load(), print_error(), pcl::TSDFVolume< VoxelT, WeightT >::save(), and pcl::visualization::PCLVisualizer::updatePolygonMesh().

◆ print_error() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_error	(	std::string	format,
		Args &&...	args
	)

Print an error message on stream with colors.

Parameters

format the message

Definition at line 323 of file print.h.

References print_error().

◆ print_highlight() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_highlight	(	const std::string	format,
		Args &&...	args
	)

Print a highlighted info message on stream with colors.

Parameters

format the message

Definition at line 462 of file print.h.

References print_highlight().

◆ print_highlight() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_highlight	(	FILE *	stream,
		const std::string	format,
		Args...	args
	)

Print a highlighted info message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 449 of file print.h.

References pcl::console::Logger::getInstance(), L_INFO, pcl::console::Logger::print_highlight(), and to_string().

Referenced by print_highlight().

◆ print_info() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_info	(	const std::string	format,
		Args &&...	args
	)

Print an info message on stream with colors.

Parameters

format the message

Definition at line 302 of file print.h.

References print_info().

◆ print_info() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_info	(	FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print an info message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 292 of file print.h.

References L_INFO, and print().

Referenced by pcl::TSDFVolume< VoxelT, WeightT >::addNeighborhood(), pcl::TSDFVolume< VoxelT, WeightT >::extractNeighborhood(), pcl::TSDFVolume< VoxelT, WeightT >::load(), print_info(), pcl::TSDFVolume< VoxelT, WeightT >::save(), and pcl::console::TicToc::toc_print().

◆ print_value() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_value	(	const std::string	format,
		Args &&...	args
	)

Print a value message on stream with colors.

Parameters

format the message

Definition at line 403 of file print.h.

References print_value().

◆ print_value() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_value	(	FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print a value message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 391 of file print.h.

References pcl::console::Logger::getInstance(), L_ALWAYS, pcl::console::Logger::print_value(), and to_string().

Referenced by pcl::TSDFVolume< VoxelT, WeightT >::load(), print_value(), pcl::TSDFVolume< VoxelT, WeightT >::save(), and pcl::console::TicToc::toc_print().

◆ print_warn() [1/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_warn	(	FILE *	stream,
		const std::string	format,
		Args &&...	args
	)

Print a warning message on stream with colors.

Parameters

stream	the output stream (stdout, stderr, etc)
format	the message

Definition at line 334 of file print.h.

References L_WARN, and print().

Referenced by print_warn(), pcl::TSDFVolume< VoxelT, WeightT >::setHeader(), and pcl::gpu::kinfuLS::TsdfVolume::setHeader().

◆ print_warn() [2/2]

template<typename... Args>

PCL_EXPORTS void pcl::console::print_warn	(	std::string	format,
		Args &&...	args
	)

Print a warning message on stream with colors.

Parameters

format the message

Definition at line 344 of file print.h.

References print_warn().

◆ reset_text_color()

PCL_EXPORTS void pcl::console::reset_text_color ( FILE * stream )

Reset the text color (on either stdout or stderr) to its original state.

Parameters

stream the output stream (stdout, stderr, etc)

◆ setCallback()

template<typename Functor >

void pcl::console::setCallback ( Functor && callback )

Sets a callable in the Logger instance, which is called whenever a printout has occured.

Template Parameters

Functor matching the definition: std::function<void(const LogRecord&)>

Parameters

callback the std::function or lambda to be called

Note: Its possible to reset the logging to console by setting the callback to a nullptr

Definition at line 255 of file print.h.

References pcl::console::Logger::getInstance(), and pcl::console::Logger::setCallback().

◆ setVerbosityLevel()

PCL_EXPORTS void pcl::console::setVerbosityLevel ( VERBOSITY_LEVEL level )

set the verbosity level

◆ to_string()

template<typename... Args>

std::string pcl::console::to_string	(	const std::string	fmt_str,
			...
	)

insert values into a formatted string

Parameters

fmt_str	string containing the format
values	to be inserted

Returns: formatted string of type std::string

Definition at line 268 of file print.h.

Referenced by print(), print(), print_color(), print_highlight(), and print_value().

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ TT_ATTIBUTES

◆ TT_COLORS

◆ VERBOSITY_LEVEL

Function Documentation

◆ change_text_color() [1/2]

◆ change_text_color() [2/2]

◆ enableColoredOutput()

◆ find_argument()

◆ find_switch()

◆ getVerbosityLevel()

◆ initVerbosityLevel()

◆ isVerbosityLevelEnabled()

◆ parse()

◆ parse_2x_arguments() [1/3]

◆ parse_2x_arguments() [2/3]

◆ parse_2x_arguments() [3/3]

◆ parse_3x_arguments() [1/3]

◆ parse_3x_arguments() [2/3]

◆ parse_3x_arguments() [3/3]

◆ parse_argument() [1/8]

◆ parse_argument() [2/8]

◆ parse_argument() [3/8]

◆ parse_argument() [4/8]

◆ parse_argument() [5/8]

◆ parse_argument() [6/8]

◆ parse_argument() [7/8]

◆ parse_argument() [8/8]

◆ parse_file_extension_argument() [1/2]

◆ parse_file_extension_argument() [2/2]

◆ parse_multiple_2x_arguments()

◆ parse_multiple_3x_arguments()

◆ parse_multiple_arguments() [1/4]

◆ parse_multiple_arguments() [2/4]

◆ parse_multiple_arguments() [3/4]

◆ parse_multiple_arguments() [4/4]

◆ parse_x_arguments() [1/3]

◆ parse_x_arguments() [2/3]

◆ parse_x_arguments() [3/3]

◆ print() [1/2]

◆ print() [2/2]

◆ print_color()

◆ print_debug() [1/2]

◆ print_debug() [2/2]

◆ print_error() [1/2]

◆ print_error() [2/2]

◆ print_highlight() [1/2]

◆ print_highlight() [2/2]

◆ print_info() [1/2]

◆ print_info() [2/2]

◆ print_value() [1/2]

◆ print_value() [2/2]

◆ print_warn() [1/2]

◆ print_warn() [2/2]

◆ reset_text_color()

◆ setCallback()

◆ setVerbosityLevel()

◆ to_string()