Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/ConsoleWriter.h @ 11532

Last change on this file since 11532 was 11071, checked in by landauf, 9 years ago

merged branch cpp11_v3 back to trunk

  • Property svn:eol-style set to native
File size: 2.3 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
40#include <ostream>
41
42#include "BaseWriter.h"
43
44namespace orxonox
45{
46    /**
47        @brief ConsoleWriter inherits from BaseWriter and writes output to the console.
48
49        This class can be seen as an equivalent to std::cout within the output system.
50    */
51    class _UtilExport ConsoleWriter : public BaseWriter
52    {
53        public:
54            ConsoleWriter(std::ostream& outputStream);
55            virtual ~ConsoleWriter();
56
57            void enable();
58            void disable();
59
60            inline const std::ostream& getOutputStream() const
61                { return this->outputStream_; }
62
63        protected:
64            virtual void printLine(const std::string& line, OutputLevel level) override;
65
66        private:
67            // non-copyable:
68            ConsoleWriter(const ConsoleWriter&) = delete;
69            ConsoleWriter& operator=(const ConsoleWriter&) = delete;
70
71            std::ostream& outputStream_; ///< The ostream to which the console writer writes its output
72            bool bEnabled_;              ///< If false, the instance will not write output to the console.
73    };
74}
75
76#endif /* _ConsoleWriter_H__ */
Note: See TracBrowser for help on using the repository browser.