Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/output/src/libraries/util/output/ConsoleWriter.h @ 8848

Last change on this file since 8848 was 8848, checked in by landauf, 13 years ago

added documentation and some comments

  • Property svn:eol-style set to native
File size: 2.0 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Output
32    @brief Declaration of the ConsoleWriter singleton which is used to write output to the console.
33*/
34
35#ifndef _ConsoleWriter_H__
36#define _ConsoleWriter_H__
37
38#include "util/UtilPrereqs.h"
39#include "BaseWriter.h"
40
41namespace orxonox
42{
43    /**
44        @brief ConsoleWriter inherits from BaseWriter and writes output to the console.
45
46        This class can be seen as an equivalent to std::cout within the output
47        system. It is implemented as a singleton for static acces.
48    */
49    class _UtilExport ConsoleWriter : public BaseWriter
50    {
51        public:
52            static ConsoleWriter& getInstance();
53
54            void enable();
55            void disable();
56
57        protected:
58            virtual void printLine(const std::string& line, OutputLevel level);
59
60        private:
61            ConsoleWriter();
62            ConsoleWriter(const ConsoleWriter&);
63            virtual ~ConsoleWriter();
64
65            bool bEnabled_; ///< If false, the instance will not write output to the console.
66    };
67}
68
69#endif /* _ConsoleWriter_H__ */
Note: See TracBrowser for help on using the repository browser.