User Manual, Developers Guide and API Documentation

MM1Step6.cpp

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

#include <WNS/queuingsystem/MM1Step6.hpp>
#include <WNS/queuingsystem/JobContextProvider.hpp>

using namespace wns::queuingsystem;

STATIC_FACTORY_REGISTER_WITH_CREATOR(
    SimpleMM1Step6,
    wns::simulator::ISimulationModel,
    "openwns.queuingsystem.SimpleMM1Step6",
    wns::PyConfigViewCreator);

SimpleMM1Step6::SimpleMM1Step6(const wns::pyconfig::View& config) :
    priorityDistribution_(Job::lowPriority, Job::highPriority),
    config_(config),
    logger_(config.get("logger")),
    idle(true),
    // Below we will put one Context Provider in the collection
    cpc_(new wns::probe::bus::ContextProviderCollection()),
    // The name of the measurement source. Must match the one configured
    // in the global Probe Bus Registry
    sojournTime_(cpc_, "SojournTime")
{
    wns::pyconfig::View disConfig = config.get("jobInterArrivalTimeDistribution");
    std::string disName = disConfig.get<std::string>("__plugin__");
    jobInterarrivalTime_ = 
        wns::distribution::DistributionFactory::creator(disName)->create(disConfig);

    disConfig = config.get("jobProcessingTimeDistribution");
    disName = disConfig.get<std::string>("__plugin__");
    jobProcessingTime_ = 
        wns::distribution::DistributionFactory::creator(disName)->create(disConfig);

    // PDU Context Provider will receive a Job PDU when probing and read
    // Context information from it
    cpc_->addProvider(JobContextProvider());
}

void
SimpleMM1Step6::doStartup()
{
    MESSAGE_SINGLE(NORMAL, logger_, "MM1Step6 started, generating first job\n" << *this);

    generateNewJob();
}

void
SimpleMM1Step6::doShutdown()
{
    assure(cpc_, "No Context Provider Collection");
    delete cpc_;
}

void
SimpleMM1Step6::generateNewJob()
{
    // Create a new job
    JobPtr job(new Job(drawJobPriority()));

    if (job->getPriority() == Job::lowPriority)
    {
        lowPriorityQueue_.push_back(job);
    }
    else
    {
        highPriorityQueue_.push_back(job);
    }


    wns::simulator::Time delayToNextJob = (*jobInterarrivalTime_)();

    MESSAGE_SINGLE(NORMAL, logger_, "Generated new job, next job in " << delayToNextJob << "s\n" << *this);

    if (idle)
    {
        processNextJob();
    }

    wns::simulator::getEventScheduler()->scheduleDelay(
        boost::bind(&SimpleMM1Step6::generateNewJob, this),
        delayToNextJob);
}

void
SimpleMM1Step6::onJobProcessed()
{
    assure(currentJob_, "onJobProcessed called with no current Job");
    // Calculate the Jobs sojourn time
    wns::simulator::Time  now;
    wns::simulator::Time  sojournTime;
    now = wns::simulator::getEventScheduler()->getTime();
    sojournTime = now - currentJob_->getCreationTime();

    // Give some debug output
    MESSAGE_SINGLE(NORMAL, logger_, "Finished a job\n" << *this);
    MESSAGE_BEGIN(NORMAL, logger_, m, "Sojourn Time of last job ");
    m << sojournTime;
    MESSAGE_END();

    // Probe the value. The Job Context Provider will automatically
    // attach information about the priority of the job.
    // It therefore requieres put() to be called with the Job
    // as an argument.
    sojournTime_.put(currentJob_, sojournTime);

    // if there are still jobs, serve them
    if ( getNumberOfJobs() > 0 )
    {
        processNextJob();
    }
    else
    {
        idle = true;
    }
}

void
SimpleMM1Step6::processNextJob()
{
    currentJob_ = getNextJob();

    wns::simulator::Time processingTime = (*jobProcessingTime_)();

    wns::simulator::getEventScheduler()->scheduleDelay(
        boost::bind(&SimpleMM1Step6::onJobProcessed, this),
        processingTime);

    idle = false;

    MESSAGE_SINGLE(NORMAL, logger_, "Processing next job, processing time: " << processingTime << "s\n" << *this);
}

int
SimpleMM1Step6::getNumberOfJobs() const
{
    return lowPriorityQueue_.size() + highPriorityQueue_.size();
}

JobPtr
SimpleMM1Step6::getNextJob()
{
    JobPtr nextJob;

    if (highPriorityQueue_.size() > 0)
    {
        nextJob = highPriorityQueue_.front();

        highPriorityQueue_.pop_front();
    }
    else if(lowPriorityQueue_.size() > 0)
    {
        nextJob = lowPriorityQueue_.front();

        lowPriorityQueue_.pop_front();
    }
    else
    {
        throw wns::Exception("getNextJob called but now Job queued. You must check for available jobs before calling getNextJob!");
    }

    return nextJob;
}

std::string
SimpleMM1Step6::doToString() const
{
    std::stringstream ss;
    ss << "Jobs in system: " << getNumberOfJobs();
    return ss.str();
}

Job::Priority
SimpleMM1Step6::drawJobPriority()
{
    if (priorityDistribution_() == static_cast<int>(Job::lowPriority))
    {
        return Job::lowPriority;
    }
    else
    {
        return Job::highPriority;
    }
}

---