Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/LogWriter.h @ 11819

Last change on this file since 11819 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.8 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 LogWriter singleton which writes output to a log-file.
33*/
34
35#ifndef _LogWriter_H__
36#define _LogWriter_H__
37
38#include "util/UtilPrereqs.h"
39
40#include <fstream>
41
42#include "BaseWriter.h"
43
44namespace orxonox
45{
46    /**
47        @brief The LogWriter class inherits from BaseWriter and writes output to a log-file.
48
49        The path of the file can be changed, in which case the file
50        is rewritten by using the output stored by MemoryWriter. This adds the
51        possibility to change the desired output levels before changing the
52        path in order to get the complete output with the new output levels
53        at the new path.
54    */
55    class _UtilExport LogWriter : public BaseWriter
56    {
57        public:
58            LogWriter();
59            virtual ~LogWriter();
60
61            void setLogDirectory(const std::string& directory);
62
63            /** @brief Returns the path to the logfile. */
64            inline std::string getPath() const
65                { return this->directory_ + '/' + this->filename_; }
66            /** @brief Returns the open file stream. */
67            inline const std::ofstream& getFile() const
68                { return this->file_; }
69
70        protected:
71            virtual void printLine(const std::string& line, OutputLevel level) override;
72
73        private:
74            // non-copyable:
75            LogWriter(const LogWriter&) = delete;
76            LogWriter& operator=(const LogWriter&) = delete;
77
78            void openFile();
79            void closeFile();
80
81            void archive(int index = 0);
82            std::string getArchivedPath(int index) const;
83
84            std::string filename_;  ///< The name of the log-file (without directory)
85            std::string directory_; ///< The directory where the log-file resided (without file-name)
86            std::ofstream file_;    ///< The output file stream.
87    };
88}
89
90#endif /* _LogWriter_H__ */
Note: See TracBrowser for help on using the repository browser.