User Manual, Developers Guide and API Documentation

MM1Step1.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/>.
 *
 ******************************************************************************/

// begin example "wns.queuingsystem.mm1step1.hpp.example"
#ifndef WNS_QUEUINGSYSTEM_MM1STEP1_HPP
#define WNS_QUEUINGSYSTEM_MM1STEP1_HPP

#include <WNS/rng/RNGen.hpp>
#include <WNS/simulator/ISimulator.hpp>
#include <WNS/simulator/ISimulationModel.hpp>
#include <WNS/logger/Logger.hpp>
#include <WNS/IOutputStreamable.hpp>
#include <WNS/pyconfig/View.hpp>
#include <WNS/distribution/Distribution.hpp>

#include <boost/bind.hpp>

// In the OpenWNS we use nested namespaces
// which reflect the directory tree
// This file is in ./src/queuingsystem/
// so the convention is to use the same namespace:

namespace wns { namespace queuingsystem {

     // Simulation model for queueing system tutorial (step 1).
     //
     // Here We implement our own simulation model. To allow the openwns
     // application to load our custom simulation model, we must inherit
     // from wns::simulator::ISimulationModel.
     //
    class SimpleMM1Step1 :
        public IOutputStreamable,
        public wns::simulator::ISimulationModel
    {
    public:
        // All simulation models must be constructible from a
        // wns::pyconfig::View.
        explicit
        SimpleMM1Step1(const wns::pyconfig::View& configuration);
        // ^ The Python class used in MM1Step1.py
        // is intentionally called the same.
        // The Python view parameter here gets the values set as member
        // in the constructor of the Python class.

    private:
        // Implementation of the ISimulationModel interface.
        // The openwns application will call this method to indicate
        // that construction of the environment (scheduler, random number
        // generator, etc.) has finished.
        //
        // We will place our own startup code here
        virtual void
        doStartup();

        // Implementation of the ISimulationModel interface.
        // The openwns application will call this method to indicate
        // that the simulation ends and the model should shut down.
        //
        // We will place our own shutdown code here
        virtual void
        doShutdown();

        // Implementation of the IOutputStreamable interface.
        // IOutputStreamable implements the stream output operator for
        // us. It will get the contents to output to the stream by
        // calling this method.
        virtual std::string
        doToString() const;

        // Generates a new job that enters the queuing system
        void
        generateNewJob();

        // Excuted after a job has been processed
        void
        onJobProcessed();

        // Starts processing of the next job if one is available
        void
        processNextJob();

        // A random number generator object pointer. 
        wns::distribution::Distribution* jobInterarrivalTime_;

        // A random number generator object that creates exponentially
        // distributed random numbers.
        wns::distribution::Distribution* jobProcessingTime_;

        // Counter for the number of jobs in our system
        int jobsInSystem_;

        // Used to access the logging subsystem
        wns::logger::Logger logger_;
    };
}
}

#endif // NOT defined WNS_QUEUINGSYSTEM_MM1STEP1_HPP
// end example

// The following block is meta data used for tha automatic generation of
// documentation by the "Doxygen" system.

---