announce.h File Reference

#include <string>

Go to the source code of this file.

Functions
void	announce (const std::string &name)
void	module_startup (const std::string &name, bool argc_valid, const std::string &usage, bool verbose=true)
void	module_startup (const std::string &name, int argc, const char **argv, int argc_expected, const std::string &argv_expected, bool verbose=true)
void	module_startup (const std::string &name, int argc, const char **argv, bool verbose=true)

Detailed Description

Functions for printing information at startup.

Copyright (C) 2002-2011 Max-Planck-Society

Author

Martin Reinecke

Definition in file announce.h.

Function Documentation

announce()

void announce

(

const std::string &

name

)

Prints a banner containing name, as well as some information about the source code and the parallelisation techniques enabled.

module_startup() [1/3]

void module_startup	(	const std::string &	name,
		bool	argc_valid,
		const std::string &	usage,
		bool	verbose = true
	)

Prints a banner containing name and checks if argc_valid is true. If not, the string usage is printed and the program is terminated.

module_startup() [2/3]

void module_startup	(	const std::string &	name,
		int	argc,
		const char **	argv,
		int	argc_expected,
		const std::string &	argv_expected,
		bool	verbose = true
	)

Prints a banner containing name and checks if argc==argc_expected. If not, a usage description is given and the program is terminated.

module_startup() [3/3]

void module_startup	(	const std::string &	name,
		int	argc,
		const char **	argv,
		bool	verbose = true
	)

Prints a banner containing name and checks if argc>=2. If not, a usage description is given and the program is terminated.

Definition at line 106 of file announce.cc.