SGIO类 参考

详细描述

Class SGIO, used to do input output operations throughout shogun.

Any debug or error or progress message is passed through the functions of this class to be in the end written to the screen. Note that messages don't have to be written to stdout or stderr, but can be redirected to a file.

在文件 SGIO.h 第 243 行定义.

Public 成员函数
	SGIO ()
	SGIO (const SGIO &orig)
virtual	~SGIO ()
void	set_loglevel (EMessageType level)
EMessageType	get_loglevel () const
bool	loglevel_above (EMessageType type) const
bool	get_show_progress () const
EMessageLocation	get_location_info () const
bool	get_syntax_highlight () const
void	message (EMessageType prio, const char *function, const char *file, int32_t line, const char *fmt,...) const
void	progress (float64_t current_val, float64_t min_val=0.0, float64_t max_val=1.0, int32_t decimals=1, const char *prefix="PROGRESS:\t")
void	absolute_progress (float64_t current_val, float64_t val, float64_t min_val=0.0, float64_t max_val=1.0, int32_t decimals=1, const char *prefix="PROGRESS:\t")
void	done ()
void	not_implemented (const char *function, const char *file, int32_t line) const
void	deprecated (const char *function, const char *file, int32_t line) const
void	buffered_message (EMessageType prio, const char *fmt,...) const
FILE *	get_target () const
void	set_target (FILE *target)
void	set_target_to_stderr ()
void	set_target_to_stdout ()
void	enable_progress ()
void	disable_progress ()
void	set_location_info (EMessageLocation location)
void	enable_syntax_highlighting ()
void	disable_syntax_highlighting ()
int32_t	ref ()
int32_t	ref_count () const
int32_t	unref ()
const char *	get_name ()

静态 Public 成员函数
static char *	skip_spaces (char *str)
static char *	skip_blanks (char *str)
static void	set_dirname (const char *dirname)
static char *	concat_filename (const char *filename)
static int	filter (CONST_DIRENT_T *d)
static char *	c_string_of_substring (substring s)
static void	print_substring (substring s)
static float32_t	float_of_substring (substring s)
static float64_t	double_of_substring (substring s)
static int32_t	int_of_substring (substring s)
static uint32_t	ulong_of_substring (substring s)
static uint32_t	ss_length (substring s)

Protected 成员函数
const char *	get_msg_intro (EMessageType prio) const

Protected 属性
FILE *	target
float64_t	last_progress_time
float64_t	progress_start_time
float64_t	last_progress
bool	show_progress
EMessageLocation	location_info
bool	syntax_highlight
EMessageType	loglevel

静态 Protected 属性
static const EMessageType	levels [NUM_LOG_LEVELS]
static const char *	message_strings_highlighted [NUM_LOG_LEVELS]
static const char *	message_strings [NUM_LOG_LEVELS]
static char	file_buffer [FBUFSIZE]
	file name buffer 更多...
static char	directory_name [FBUFSIZE]
	directory name buffer 更多...

构造及析构函数说明

SGIO

(

)

default constructor

在文件 SGIO.cpp 第 47 行定义.

SGIO

(

const SGIO &

orig

)

copy constructor

在文件 SGIO.cpp 第 55 行定义.

~SGIO ( )

virtual

destructor

在文件 SGIO.cpp 第 401 行定义.

成员函数说明

void absolute_progress	(	float64_t	current_val,
		float64_t	val,
		float64_t	min_val = 0.0,
		float64_t	max_val = 1.0,
		int32_t	decimals = 1,
		const char *	prefix = "PROGRESS:\t"
	)

print absolute progress bar

参数

current_val	current value
val	value
min_val	minimum value
max_val	maximum value
decimals	decimals
prefix	message prefix

在文件 SGIO.cpp 第 198 行定义.

void buffered_message	(	EMessageType	prio,
		const char *	fmt,
			...
	)		const

print a buffered message

参数

prio	message priority
fmt	format string

在文件 SGIO.cpp 第 133 行定义.

char * c_string_of_substring ( substring  s )

static

Return a C string from the substring

参数

s

substring

返回

new C string representation

在文件 SGIO.cpp 第 321 行定义.

char * concat_filename ( const char *  filename )

static

concatenate directory and filename ( non thread safe )

参数

filename

new filename

返回

concatenated directory and filename

在文件 SGIO.cpp 第 375 行定义.

void deprecated	(	const char *	function,
		const char *	file,
		int32_t	line
	)		const

print warning message 'function deprecated'

在文件 SGIO.h 第 355 行定义.

void disable_progress

(

)

disable progress bar

在文件 SGIO.h 第 414 行定义.

void disable_syntax_highlighting

(

)

disable syntax highlighting

在文件 SGIO.h 第 446 行定义.

void done

(

)

print 'done' with priority INFO, but only if progress bar is enabled

在文件 SGIO.cpp 第 249 行定义.

float64_t double_of_substring ( substring  s )

static

Return value of substring as double

参数

s

substring

返回

substring as double

在文件 SGIO.cpp 第 346 行定义.

void enable_progress

(

)

enable progress bar

在文件 SGIO.h 第 404 行定义.

void enable_syntax_highlighting

(

)

enable syntax highlighting

在文件 SGIO.h 第 437 行定义.

int filter ( CONST_DIRENT_T *  d )

static

filter

参数

d	directory entry

返回

1 if d is a readable file

在文件 SGIO.cpp 第 384 行定义.

float32_t float_of_substring ( substring  s )

static

Get value of substring as float (if possible)

参数

s

substring

返回

float32_t value of substring

在文件 SGIO.cpp 第 336 行定义.

EMessageLocation get_location_info

(

)

const

show location where printing occurs

在文件 SGIO.h 第 287 行定义.

EMessageType get_loglevel

(

)

const

get loglevel

返回

level of log messages

在文件 SGIO.cpp 第 285 行定义.

const char * get_msg_intro ( EMessageType  prio ) const

protected

get message intro

参数

prio	message priority

返回

message intro or NULL if message is not to be printed

在文件 SGIO.cpp 第 300 行定义.

const char* get_name

(

)

返回

object name

在文件 SGIO.h 第 547 行定义.

bool get_show_progress

(

)

const

get show_progress

返回

if progress bar is shown

在文件 SGIO.h 第 280 行定义.

bool get_syntax_highlight

(

)

const

get syntax highlight

返回

if syntax highlighting is enabled

在文件 SGIO.h 第 296 行定义.

FILE* get_target

(

)

const

get target

返回

file descriptor for target

在文件 SGIO.h 第 386 行定义.

int32_t int_of_substring ( substring  s )

static

Integer value of substring

参数

s

substring

返回

int value of substring

在文件 SGIO.cpp 第 356 行定义.

bool loglevel_above

(

EMessageType

type

)

const

loglevel above

返回

whether loglevel is above specified level and thus the message should be printed

在文件 SGIO.h 第 271 行定义.

void message	(	EMessageType	prio,
		const char *	function,
		const char *	file,
		int32_t	line,
		const char *	fmt,
			...
	)		const

print a message

optionally prefixed with file name and line number from (use -1 in line to disable this)

参数

prio	message priority
function	the function name from where the message is called
file	file name from where the message is called
line	line number from where the message is called
fmt	format string

在文件 SGIO.cpp 第 66 行定义.

void not_implemented	(	const char *	function,
		const char *	file,
		int32_t	line
	)		const

print error message 'not implemented'

在文件 SGIO.h 第 349 行定义.

void print_substring ( substring  s )

static

Print the substring

参数

s

substring

在文件 SGIO.cpp 第 329 行定义.

void progress	(	float64_t	current_val,
		float64_t	min_val = 0.0,
		float64_t	max_val = 1.0,
		int32_t	decimals = 1,
		const char *	prefix = "PROGRESS:\t"
	)

print progress bar

参数

current_val	current value
min_val	minimum value
max_val	maximum value
decimals	decimals
prefix	message prefix

在文件 SGIO.cpp 第 147 行定义.

int32_t ref

(

)

increase reference counter

返回

reference count

在文件 SGIO.cpp 第 406 行定义.

int32_t ref_count

(

)

const

display reference counter

返回

reference count

在文件 SGIO.cpp 第 411 行定义.

static void set_dirname ( const char *  dirname )

static

set directory name

参数

dirname

new directory name

在文件 SGIO.h 第 458 行定义.

void set_location_info

(

EMessageLocation

location

)

enable displaying of file and line when printing messages etc

参数

location

location info (none, function, ...)

在文件 SGIO.h 第 428 行定义.

void set_loglevel

(

EMessageType

level

)

set loglevel

参数

level

level of log messages

在文件 SGIO.cpp 第 290 行定义.

void set_target

(

FILE *

target

)

set target

参数

target

file descriptor for target

在文件 SGIO.cpp 第 295 行定义.

void set_target_to_stderr

(

)

set target to stderr

在文件 SGIO.h 第 398 行定义.

void set_target_to_stdout

(

)

set target to stdout

在文件 SGIO.h 第 401 行定义.

char * skip_blanks ( char *  str )

static

skip leading spaces + tabs

参数

str	string in which to look for blanks

返回

string after after skipping leading blanks

在文件 SGIO.cpp 第 271 行定义.

char * skip_spaces ( char *  str )

static

skip leading spaces

参数

str	string in which to look for spaces

返回

string after after skipping leading spaces

在文件 SGIO.cpp 第 257 行定义.

uint32_t ss_length ( substring  s )

static

Length of substring

参数

s

substring

返回

length of substring

在文件 SGIO.cpp 第 370 行定义.

uint32_t ulong_of_substring ( substring  s )

static

Unsigned long value of substring

参数

s

substring

返回

unsigned long value of substring

在文件 SGIO.cpp 第 365 行定义.

int32_t unref

(

)

decrement reference counter and deallocate object if refcount is zero before or after decrementing it

返回

reference count

在文件 SGIO.cpp 第 416 行定义.

类成员变量说明

char directory_name

staticprotected

directory name buffer

directory name (for filter function)

在文件 SGIO.h 第 587 行定义.

char file_buffer

staticprotected

file name buffer

file buffer

在文件 SGIO.h 第 585 行定义.

float64_t last_progress

protected

last progress

在文件 SGIO.h 第 566 行定义.

float64_t last_progress_time

protected

last progress time

在文件 SGIO.h 第 562 行定义.

const EMessageType levels

staticprotected

初始值:

={MSG_GCDEBUG, MSG_DEBUG, MSG_INFO, MSG_NOTICE,
    MSG_WARN, MSG_ERROR, MSG_CRITICAL, MSG_ALERT, MSG_EMERGENCY, MSG_MESSAGEONLY}

available log levels

在文件 SGIO.h 第 578 行定义.

EMessageLocation location_info

protected

if each print function should append filename and linenumber of where the print occurs etc

在文件 SGIO.h 第 571 行定义.

EMessageType loglevel

protected

log level

在文件 SGIO.h 第 576 行定义.

const char * message_strings

staticprotected

初始值:

={"[GCDEBUG] \0", "[DEBUG] \0", "[INFO] \0",
    "[NOTICE] \0", "[WARN] \0", "[ERROR] \0",
    "[CRITICAL] \0", "[ALERT] \0", "[EMERGENCY] \0", "\0"}

message strings

在文件 SGIO.h 第 582 行定义.

const char * message_strings_highlighted

staticprotected

初始值:

={"[GCDEBUG] \0", "[DEBUG] \0", "[INFO] \0",
    "[NOTICE] \0", "\033[1;34m[WARN]\033[0m \0", "\033[1;31m[ERROR]\033[0m \0",
    "[CRITICAL] \0", "[ALERT] \0", "[EMERGENCY] \0", "\0"}

message strings syntax highlighted

在文件 SGIO.h 第 580 行定义.

float64_t progress_start_time

protected

progress start time

在文件 SGIO.h 第 564 行定义.

bool show_progress

protected

if progress bar shall be shown

在文件 SGIO.h 第 568 行定义.

bool syntax_highlight

protected

whether syntax highlighting is enabled

在文件 SGIO.h 第 573 行定义.

FILE* target

protected

target file

在文件 SGIO.h 第 560 行定义.

---

该类的文档由以下文件生成:

• SGIO.h
• SGIO.cpp