User Manual, Developers Guide and API Documentation

ISimulator.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_SIMULATOR_ISIMULATOR_HPP
#define WNS_SIMULATOR_ISIMULATOR_HPP

#include <WNS/pyconfig/View.hpp>
#include <WNS/container/UntypedRegistry.hpp>
#include <WNS/rng/RNGen.hpp>

#include <boost/signal.hpp>

#include <memory>

namespace wns { namespace events { namespace scheduler {
    class Interface;
}}}

namespace wns { namespace logger {
    class Master;
}}

namespace wns { namespace probe { namespace bus {
    class ProbeBusRegistry;
}}}

namespace wns { namespace simulator {

    typedef boost::signal0<void> ResetSignal;
    typedef boost::signal0<void> ShutdownSignal;
    typedef wns::container::UntypedRegistry<std::string> Registry;

    class ISimulator
    {
    public:
        virtual
        ~ISimulator();

        wns::events::scheduler::Interface*
        getEventScheduler() const;

        wns::logger::Master*
        getMasterLogger() const;

        wns::rng::RNGen*
        getRNG() const;

        wns::pyconfig::View
        getConfiguration() const;

        wns::probe::bus::ProbeBusRegistry*
        getProbeBusRegistry() const;

        Registry*
        getRegistry() const;

        ResetSignal*
        getResetSignal() const;

        ShutdownSignal*
        getShutdownSignal() const;

        void
        reset();

    private:
        virtual wns::events::scheduler::Interface*
        doGetEventScheduler() const = 0;

        virtual wns::logger::Master*
        doGetMasterLogger() const = 0;

        virtual wns::rng::RNGen*
        doGetRNG() const = 0;

        virtual wns::pyconfig::View
        doGetConfiguration() const = 0;

        virtual wns::probe::bus::ProbeBusRegistry*
        doGetProbeBusRegistry() const = 0;

        virtual Registry*
        doGetRegistry() const = 0;

        virtual ResetSignal*
        doGetResetSignal() const = 0;

        virtual ShutdownSignal*
        doGetShutdownSignal() const = 0;

        virtual void
        doReset() = 0;
    };


    class Singleton
    {
    public:
        explicit
        Singleton();

        virtual
        ~Singleton();

        ISimulator*
        getInstance();

        void
        setInstance(ISimulator* simulator);

        void
        shutdownInstance();

    private:
        std::auto_ptr<ISimulator> simulator_;
    };

    Singleton&
    getSingleton();

    ISimulator*
    getInstance();

    wns::events::scheduler::Interface*
    getEventScheduler();

    wns::logger::Master*
    getMasterLogger();

    wns::rng::RNGen*
    getRNG();

    wns::probe::bus::ProbeBusRegistry*
    getProbeBusRegistry();

    Registry*
    getRegistry();

    wns::pyconfig::View
    getConfiguration();

    ResetSignal*
    getResetSignal();

    ShutdownSignal*
    getShutdownSignal();

} // namespace simulator
} // namesapce wns


#endif // NOT defined WNS_SIMULATOR_ISIMULATOR_HPP

---