Ascii.hpp File Reference

#include "gstlearn_export.hpp"

Functions
GSTLEARN_EXPORT void	ascii_study_define (const char *study)
GSTLEARN_EXPORT void	ascii_environ_read (char *file_name, int verbose)
GSTLEARN_EXPORT void	ascii_filename (const char *type, int rank, int mode, char *filename)
GSTLEARN_EXPORT void	ascii_simu_read (char *file_name, int verbose, int *nbsimu, int *nbtuba, int *seed)
GSTLEARN_EXPORT int	ascii_option_defined (const char *file_name, int verbose, const char *option_name, int type, void *answer)

Function Documentation

ascii_environ_read()

GSTLEARN_EXPORT void ascii_environ_read	(	char *	file_name,
		int	verbose
	)

Read the Environment definition file

Parameters

[in]	file_name	Name of the ASCII file
[in]	verbose	Verbose option if the file cannot be opened

ascii_filename()

GSTLEARN_EXPORT void ascii_filename	(	const char *	type,
		int	rank,
		int	mode,
		char *	filename
	)

Returns the name of the file

Parameters

[in]	type	Type of the file to be named
[in]	rank	Rank of the file (optional)
[in]	mode	0 for read; 1 for write
[out]	filename	Output filename

ascii_option_defined()

GSTLEARN_EXPORT int ascii_option_defined	(	const char *	file_name,
		int	verbose,
		const char *	option_name,
		int	type,
		void *	answer
	)

Check if an option is defined in the Options ASCII file

Returns

1 if the option is defined and 0 otherwise

Parameters

[in]	file_name	Name of the ASCII file
[in]	verbose	Verbose option if the file cannot be opened
[in]	option_name	Keyword for the requested option
[in]	type	Answer type 0 : Logical (returned as 0 or 1) 1 : integer 2 : real (returned as a double)
[out]	answer	Answer

ascii_simu_read()

GSTLEARN_EXPORT void ascii_simu_read	(	char *	file_name,
		int	verbose,
		int *	nbsimu,
		int *	nbtuba,
		int *	seed
	)

Read the Simulation Characteristics

Parameters

[in]	file_name	Name of the ASCII file
[in]	verbose	Verbose option if the file cannot be opened
[out]	nbsimu	Number of simulations
[out]	nbtuba	Number of turning bands
[out]	seed	Seed for the random number generator

ascii_study_define()

GSTLEARN_EXPORT void ascii_study_define

(

const char *

study

)

Set the Study for the test data

Parameters

[in]

study

Local name of the study