io.hpp File Reference

#include "gstlearn_export.hpp"
#include <stdarg.h>
#include <stdio.h>

Functions
GSTLEARN_EXPORT int	_file_read (FILE *file, const char *format, va_list ap)
GSTLEARN_EXPORT int	_file_get_ncol (FILE *file)
GSTLEARN_EXPORT void	_file_delimitors (char del_com, const char *del_sep, char del_blk)
GSTLEARN_EXPORT FILE *	_file_open (const char *filename, int mode)
GSTLEARN_EXPORT int	_record_read (FILE *file, const char *format,...)
GSTLEARN_EXPORT int	_buffer_read (char **buffer, const char *format, va_list ap)
GSTLEARN_EXPORT void	_file_write (FILE *file, const char *format, va_list ap)
GSTLEARN_EXPORT void	_buffer_write (char *buffer, const char *format, va_list ap)
GSTLEARN_EXPORT void	_lire_string (const char *question, int flag_def, const char *valdef, char *answer)
GSTLEARN_EXPORT int	_lire_int (const char *question, int flag_def, int valdef, int valmin, int valmax)
GSTLEARN_EXPORT double	_lire_double (const char *question, int flag_def, double valdef, double valmin, double valmax)
GSTLEARN_EXPORT int	_lire_logical (const char *question, int flag_def, int valdef)
GSTLEARN_EXPORT void	_erase_current_string (void)

Function Documentation

_buffer_read()

GSTLEARN_EXPORT int _buffer_read	(	char **	buffer,
		const char *	format,
		va_list	ap
	)

Read the next token from the buffer

Returns

-1 if the end-of-record has been found

1 for a decoding error

0 otherwise

Parameters

[in]	buffer	Buffer to be read
[in]	format	format
[out]	ap	va_list containing the read variables

This method is not documented on purpose. It should remain private

_buffer_write()

GSTLEARN_EXPORT void _buffer_write	(	char *	buffer,
		const char *	format,
		va_list	ap
	)

Write the next token into the buffer

Parameters

[in]	buffer	Writing buffer
[in]	format	Encoding format
[in]	ap	va_list to be written

This method is not documented on purpose. It should remain private

_erase_current_string()

GSTLEARN_EXPORT void _erase_current_string

(

void

)

Erase the current decoding string

This method is not documented on purpose. It should remain private

_file_delimitors()

GSTLEARN_EXPORT void _file_delimitors	(	char	del_com,
		const char *	del_sep,
		char	del_blk
	)

Define the file delimitors

Parameters

[in]	del_com	Delimitor for comments
[in]	del_sep	Delimitor for separator
[in]	del_blk	Delimitor for blank

This method is not documented on purpose. It should remain private

_file_get_ncol()

GSTLEARN_EXPORT int _file_get_ncol

(

FILE *

file

)

Get the number of tokens in the line

Returns

Number of tokens

Parameters

[in]

file

FILE structure

This method is not documented on purpose. It should remain private

_file_open()

GSTLEARN_EXPORT FILE* _file_open	(	const char *	filename,
		int	mode
	)

Open an ASCII file

Returns

FILE returned pointer

Parameters

[in]	filename	Local file name
[in]	mode	type of file (OLD or NEW)

This method is not documented on purpose. It should remain private

_file_read()

GSTLEARN_EXPORT int _file_read	(	FILE *	file,
		const char *	format,
		va_list	ap
	)

Read the next token from the file

Returns

-1 if the end-of-file has been found

1 for a decoding error

0 otherwise

Parameters

[in]	file	FILE structure
[in]	format	format
[in]	ap	Value to be read

This method is not documented on purpose. It should remain private

_file_write()

GSTLEARN_EXPORT void _file_write	(	FILE *	file,
		const char *	format,
		va_list	ap
	)

Write the next token from the file

Parameters

[in]	file	FILE structure
[in]	format	Encoding format
[in]	ap	Value to be written

This method is not documented on purpose. It should remain private

_lire_double()

GSTLEARN_EXPORT double _lire_double	(	const char *	question,
		int	flag_def,
		double	valdef,
		double	valmin,
		double	valmax
	)

Read a double value

Returns

Double value

Parameters

[in]	question	Question to be asked
[in]	flag_def	1 if the default is authorized; 0 otherwise
[in]	valdef	Default value or TEST
[in]	valmin	Minimum authorized value or TEST
[in]	valmax	Maximum authorized value or TEST

This method is not documented on purpose. It should remain private

_lire_int()

GSTLEARN_EXPORT int _lire_int	(	const char *	question,
		int	flag_def,
		int	valdef,
		int	valmin,
		int	valmax
	)

Read an integer value

Returns

Integer value

Parameters

[in]	question	Question to be asked
[in]	flag_def	1 if the default is authorized; 0 otherwise
[in]	valdef	Default value or ITEST
[in]	valmin	Minimum authorized value or ITEST
[in]	valmax	Maximum authorized value or ITEST

This method is not documented on purpose. It should remain private

_lire_logical()

GSTLEARN_EXPORT int _lire_logical	(	const char *	question,
		int	flag_def,
		int	valdef
	)

Read a boolean answer

Returns

Integer value: 1 for 'yes' and 0 for 'no'

Parameters

[in]	question	Question to be asked
[in]	flag_def	1 if the default is authorized; 0 otherwise
[in]	valdef	Default value (0 for NO and 1 for YES)

This method is not documented on purpose. It should remain private

_lire_string()

GSTLEARN_EXPORT void _lire_string	(	const char *	question,
		int	flag_def,
		const char *	valdef,
		char *	answer
	)

Read astring

Parameters

[in]	question	Question to be asked
[in]	flag_def	1 if the default is authorized; 0 otherwise
[in]	valdef	Default string
[out]	answer	Answering string

This method is not documented on purpose. It should remain private

_record_read()

GSTLEARN_EXPORT int _record_read	(	FILE *	file,
		const char *	format,
			...
	)

Read the next record

Returns

Error return code

Parameters

[in]	file	Pointer to the file to be read
[in]	format	Encoding format
[in]	...	Value to be written

This method is not documented on purpose. It should remain private