announce.h

Go to the documentation of this file.
00001 /*
00002  *  This file is part of libcxxsupport.
00003  *
00004  *  libcxxsupport is free software; you can redistribute it and/or modify
00005  *  it under the terms of the GNU General Public License as published by
00006  *  the Free Software Foundation; either version 2 of the License, or
00007  *  (at your option) any later version.
00008  *
00009  *  libcxxsupport is distributed in the hope that it will be useful,
00010  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  *  GNU General Public License for more details.
00013  *
00014  *  You should have received a copy of the GNU General Public License
00015  *  along with libcxxsupport; if not, write to the Free Software
00016  *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00017  */
00018 
00019 /*
00020  *  libcxxsupport is being developed at the Max-Planck-Institut fuer Astrophysik
00021  *  and financially supported by the Deutsches Zentrum fuer Luft- und Raumfahrt
00022  *  (DLR).
00023  */
00024 
00025 /*! \file announce.h
00026  *  Functions for printing information at startup.
00027  *
00028  *  Copyright (C) 2002-2011 Max-Planck-Society
00029  *  \author Martin Reinecke
00030  */
00031 
00032 #ifndef PLANCK_ANNOUNCE_H
00033 #define PLANCK_ANNOUNCE_H
00034 
00035 #include <string>
00036 
00037 /*! Prints a banner containing \a name, as well as some information about the
00038     source code and the parallelisation techniques enabled. */
00039 void announce (const std::string &name);
00040 
00041 /*! Prints a banner containing \a name and checks if \a argc_valid is true.
00042     If not, the string \a usage is printed and the program is terminated. */
00043 void module_startup (const std::string &name, bool argc_valid,
00044   const std::string &usage, bool verbose=true);
00045 
00046 /*! Prints a banner containing \a name and checks if \a argc==argc_expected.
00047     If not, a usage description is given and the program is terminated. */
00048 void module_startup (const std::string &name, int argc, const char **argv,
00049   int argc_expected, const std::string &argv_expected, bool verbose=true);
00050 
00051 /*! Prints a banner containing \a name and checks if \a argc>=2.
00052     If not, a usage description is given and the program is terminated. */
00053 void module_startup (const std::string &name, int argc, const char **argv,
00054   bool verbose=true);
00055 
00056 #endif

Generated on Thu Oct 8 14:48:51 2015 for LevelS C++ support library