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

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

/**
    @file
    @ingroup Output
    @brief Declaration of the ConsoleWriter singleton which is used to write output to the console.
*/

#ifndef _ConsoleWriter_H__
#define _ConsoleWriter_H__

#include "util/UtilPrereqs.h"

#include <ostream>

#include "BaseWriter.h"

namespace orxonox
{
    /**
        @brief ConsoleWriter inherits from BaseWriter and writes output to the console.

        This class can be seen as an equivalent to std::cout within the output system.
    */
    class _UtilExport ConsoleWriter : public BaseWriter
    {
        public:
            ConsoleWriter(std::ostream& outputStream);
            ConsoleWriter(const ConsoleWriter&);
            virtual ~ConsoleWriter();

            void enable();
            void disable();

            inline const std::ostream& getOutputStream() const
                { return this->outputStream_; }

        protected:
            virtual void printLine(const std::string& line, OutputLevel level);

        private:
            std::ostream& outputStream_; ///< The ostream to which the console writer writes its output
            bool bEnabled_;              ///< If false, the instance will not write output to the console.
    };
}

#endif /* _ConsoleWriter_H__ */