Point Cloud Library (PCL)  1.14.1-dev
Classes | Enumerations | Functions
pcl::console Namespace Reference

Classes

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". More...
 
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". More...
 
template<typename Type >
int parse (int argc, const char *const *argv, const char *argument_name, Type &value)
 Template version for parsing arguments. More...
 
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. More...
 
PCL_EXPORTS int parse_argument (int argc, const char *const *argv, const char *str, bool &val)
 Parse for a specific given command line argument. More...
 
PCL_EXPORTS int parse_argument (int argc, const char *const *argv, const char *str, float &val)
 Parse for a specific given command line argument. More...
 
PCL_EXPORTS int parse_argument (int argc, const char *const *argv, const char *str, double &val)
 Parse for a specific given command line argument. More...
 
PCL_EXPORTS int parse_argument (int argc, const char *const *argv, const char *str, int &val)
 Parse for a specific given command line argument. More...
 
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. More...
 
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. More...
 
PCL_EXPORTS int parse_argument (int argc, const char *const *argv, const char *str, char &val)
 Parse for a specific given command line argument. More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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). More...
 
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. More...
 
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. More...
 
PCL_EXPORTS void setVerbosityLevel (VERBOSITY_LEVEL level)
 set the verbosity level More...
 
PCL_EXPORTS VERBOSITY_LEVEL getVerbosityLevel ()
 get the verbosity level. More...
 
PCL_EXPORTS bool initVerbosityLevel ()
 initialize verbosity level. More...
 
PCL_EXPORTS bool isVerbosityLevelEnabled (VERBOSITY_LEVEL severity)
 is verbosity level enabled? More...
 
PCL_EXPORTS void enableColoredOutput (FILE *stream, bool enable)
 Enable or disable colored text output, overriding the default behavior. More...
 
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. More...
 
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. More...
 
PCL_EXPORTS void reset_text_color (FILE *stream)
 Reset the text color (on either stdout or stderr) to its original state. More...
 
PCL_EXPORTS void print_color (FILE *stream, int attr, int fg, const char *format,...)
 Print a message on stream with colors. More...
 
PCL_EXPORTS void print_info (const char *format,...)
 Print an info message on stream with colors. More...
 
PCL_EXPORTS void print_info (FILE *stream, const char *format,...)
 Print an info message on stream with colors. More...
 
PCL_EXPORTS void print_highlight (const char *format,...)
 Print a highlighted info message on stream with colors. More...
 
PCL_EXPORTS void print_highlight (FILE *stream, const char *format,...)
 Print a highlighted info message on stream with colors. More...
 
PCL_EXPORTS void print_error (const char *format,...)
 Print an error message on stream with colors. More...
 
PCL_EXPORTS void print_error (FILE *stream, const char *format,...)
 Print an error message on stream with colors. More...
 
PCL_EXPORTS void print_warn (const char *format,...)
 Print a warning message on stream with colors. More...
 
PCL_EXPORTS void print_warn (FILE *stream, const char *format,...)
 Print a warning message on stream with colors. More...
 
PCL_EXPORTS void print_debug (const char *format,...)
 Print a debug message on stream with colors. More...
 
PCL_EXPORTS void print_debug (FILE *stream, const char *format,...)
 Print a debug message on stream with colors. More...
 
PCL_EXPORTS void print_value (const char *format,...)
 Print a value message on stream with colors. More...
 
PCL_EXPORTS void print_value (FILE *stream, const char *format,...)
 Print a value message on stream with colors. More...
 
PCL_EXPORTS void print (VERBOSITY_LEVEL level, FILE *stream, const char *format,...)
 Print a message on stream. More...
 
PCL_EXPORTS void print (VERBOSITY_LEVEL level, const char *format,...)
 Print a message. More...
 

Enumeration Type Documentation

◆ TT_ATTIBUTES

Enumerator
TT_RESET 
TT_BRIGHT 
TT_DIM 
TT_UNDERLINE 
TT_BLINK 
TT_REVERSE 
TT_HIDDEN 

Definition at line 88 of file print.h.

◆ TT_COLORS

Enumerator
TT_BLACK 
TT_RED 
TT_GREEN 
TT_YELLOW 
TT_BLUE 
TT_MAGENTA 
TT_CYAN 
TT_WHITE 

Definition at line 99 of file print.h.

◆ VERBOSITY_LEVEL

Enumerator
L_ALWAYS 
L_ERROR 
L_WARN 
L_INFO 
L_DEBUG 
L_VERBOSE 

Definition at line 111 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
streamthe output stream (stdout, stderr, etc)
attributethe text attribute
fgthe 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
streamthe output stream (stdout, stderr, etc)
attributethe text attribute
fgthe foreground color
bgthe 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
streamthe output stream (stdout, stderr, etc)
enablewhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]argument_namethe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]argument_namethe 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)

◆ 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]argument_namethe name of the argument to search for
[out]valueThe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[out]tthe third output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[out]tthe third output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]fthe first output value
[out]sthe second output value
[out]tthe third output value
[in]debugwhether 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]extthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]extensionsthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]values_fthe first vector of output values
[out]values_sthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]values_fthe first vector of output values
[out]values_sthe second vector of output values
[out]values_tthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]valuesthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]valuesthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]valuesthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe string value to search for
[out]valuesthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]vthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]vthe 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]argcthe number of command line arguments
[in]argvthe command line arguments
[in]strthe command line argument to search for
[out]vthe 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]

PCL_EXPORTS void pcl::console::print ( VERBOSITY_LEVEL  level,
const char *  format,
  ... 
)

Print a message.

Parameters
levelthe verbosity level
formatthe message

◆ print() [2/2]

PCL_EXPORTS void pcl::console::print ( VERBOSITY_LEVEL  level,
FILE *  stream,
const char *  format,
  ... 
)

Print a message on stream.

Parameters
levelthe verbosity level
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_color()

PCL_EXPORTS void pcl::console::print_color ( FILE *  stream,
int  attr,
int  fg,
const char *  format,
  ... 
)

Print a message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
attrthe text attribute
fgthe foreground color
formatthe message

◆ print_debug() [1/2]

PCL_EXPORTS void pcl::console::print_debug ( const char *  format,
  ... 
)

Print a debug message on stream with colors.

Parameters
formatthe message

◆ print_debug() [2/2]

PCL_EXPORTS void pcl::console::print_debug ( FILE *  stream,
const char *  format,
  ... 
)

Print a debug message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_error() [1/2]

PCL_EXPORTS void pcl::console::print_error ( const char *  format,
  ... 
)

◆ print_error() [2/2]

PCL_EXPORTS void pcl::console::print_error ( FILE *  stream,
const char *  format,
  ... 
)

Print an error message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_highlight() [1/2]

PCL_EXPORTS void pcl::console::print_highlight ( const char *  format,
  ... 
)

Print a highlighted info message on stream with colors.

Parameters
formatthe message

◆ print_highlight() [2/2]

PCL_EXPORTS void pcl::console::print_highlight ( FILE *  stream,
const char *  format,
  ... 
)

Print a highlighted info message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_info() [1/2]

PCL_EXPORTS void pcl::console::print_info ( const char *  format,
  ... 
)

◆ print_info() [2/2]

PCL_EXPORTS void pcl::console::print_info ( FILE *  stream,
const char *  format,
  ... 
)

Print an info message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_value() [1/2]

PCL_EXPORTS void pcl::console::print_value ( const char *  format,
  ... 
)

Print a value message on stream with colors.

Parameters
formatthe message

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

◆ print_value() [2/2]

PCL_EXPORTS void pcl::console::print_value ( FILE *  stream,
const char *  format,
  ... 
)

Print a value message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ print_warn() [1/2]

PCL_EXPORTS void pcl::console::print_warn ( const char *  format,
  ... 
)

Print a warning message on stream with colors.

Parameters
formatthe message

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

◆ print_warn() [2/2]

PCL_EXPORTS void pcl::console::print_warn ( FILE *  stream,
const char *  format,
  ... 
)

Print a warning message on stream with colors.

Parameters
streamthe output stream (stdout, stderr, etc)
formatthe message

◆ 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
streamthe output stream (stdout, stderr, etc)

◆ setVerbosityLevel()

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

set the verbosity level