User Manual, Developers Guide and API Documentation

Master.hpp

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of openWNS (open Wireless Network Simulator)
 * _____________________________________________________________________________
 *
 * Copyright (C) 2004-2007
 * Chair of Communication Networks (ComNets)
 * Kopernikusstr. 16, D-52074 Aachen, Germany
 * phone: ++49-241-80-27910,
 * fax: ++49-241-80-22242
 * email: info@openwns.org
 * www: http://www.openwns.org
 * _____________________________________________________________________________
 *
 * openWNS is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 2 as published by the
 * Free Software Foundation;
 *
 * openWNS 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/

#ifndef WNS_LOGGER_MASTER_HPP
#define WNS_LOGGER_MASTER_HPP

#include <WNS/pyconfig/View.hpp>
#include <WNS/PyConfigViewCreator.hpp>
#include <WNS/logger/OutputStrategy.hpp>
#include <WNS/logger/FormatStrategy.hpp>

#include <WNS/simulator/ISimulator.hpp>
#include <WNS/events/scheduler/Interface.hpp>

#include <string>
#include <map>
#include <deque>

namespace wns { namespace logger {
    class Master
    {
        typedef std::map<OutputStrategy*, FormatStrategy*> LoggerChain;
    public:
        explicit
        Master();

        explicit
        Master(const pyconfig::View& pyco);

        virtual
        ~Master();

        void
        configure(const pyconfig::View& pyco);

        void
        registerLogger(const std::string& aModuleRef,
                   const std::string& aLocationRef);

        void
        write(const std::string& aModuleRef,
              const std::string& aLocationRef,
              const std::string& aMsgRef)
        {
            if (doLogging)
            {
                // If we have loggin enabled we have to process
                // the message
                RawMessage m;
                m.time = wns::simulator::getEventScheduler()->getTime();
                m.module = aModuleRef;
                m.location = aLocationRef;
                m.message = aMsgRef;

                if (haveBacktrace)
                {
                    // if we have logging enabled, and the
                    // backtracing is enabled we will not
                    // write the message, but rather keep it
                    // in the backtrace buffer
                    saveForBacktrace(m);
                }
                else
                {
                    // if we have logging enabled and
                    // backtrace disable we are going to
                    // write the message
                    outputMessage(m);
                }
            }
            // If we have don't have debugging and backtrace
            // enabled we will do nothing
        };

        void outputBacktrace() const;

        bool isEnabled() const;

    private:
        bool doLogging;
        bool haveBacktrace;
        size_t numberOfLinesForBacktrace;
        std::deque<RawMessage> backtrace;

        LoggerChain loggerChain;

        void saveForBacktrace(const RawMessage& m);
        void outputMessage(const RawMessage& m) const;
        void clearLoggerChain();
    }; // Master

} // logger
} // wns
#endif // not defined WNS_LOGGER_MASTER_HPP

---