sat-onoff-example.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Magister Solutions
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Sami Rantanen <sami.rantanen@magister.fi>
 *
 */
 
#include "ns3/applications-module.h"
#include "ns3/core-module.h"
#include "ns3/internet-module.h"
#include "ns3/network-module.h"
#include "ns3/satellite-module.h"
 
using namespace ns3;
 
NS_LOG_COMPONENT_DEFINE("OnOff-example");
 
int
main(int argc, char* argv[])
{
    uint32_t packetSize = 512;
    std::string dataRate = "500kb/s";
    std::string onTime = "1.0";
    std::string offTime = "0.5";
    std::string scenario = "simple";
    std::string sender = "both";
    std::string simDuration = "11s";
 
    auto simulationHelper = CreateObject<SimulationHelper>("example-onoff");
    Config::SetDefault("ns3::SatEnvVariables::EnableSimulationOutputOverwrite", BooleanValue(true));
    Config::SetDefault("ns3::SatHelper::ScenarioCreationTraceEnabled", BooleanValue(true));
 
    // enable packet traces on satellite modules
    Config::SetDefault("ns3::SatHelper::PacketTraceEnabled", BooleanValue(true));
 
    SatHelper::PreDefinedScenario_t satScenario = SatHelper::SIMPLE;
 
    // read command line parameters given by user
    CommandLine cmd;
    cmd.AddValue("packetSize", "Size of constant packet (bytes e.g 512)", packetSize);
    cmd.AddValue("dataRate", "Data rate (e.g. 500kb/s)", dataRate);
    cmd.AddValue("onTime", "Time for packet sending is on in seconds, (e.g. (1.0)", onTime);
    cmd.AddValue("offTime", "Time for packet sending is off in seconds, (e.g. (0.5)", offTime);
    cmd.AddValue("sender", "Packet sender (ut, gw, or both).", sender);
    cmd.AddValue("scenario", "Test scenario to use. (simple, larger or full", scenario);
    cmd.AddValue("simDuration", "Duration of the simulation (Time)", simDuration);
    simulationHelper->AddDefaultUiArguments(cmd);
    cmd.Parse(argc, argv);
 
    simulationHelper->SetSimulationTime(Time(simDuration));
    simulationHelper->SetOutputTag(scenario);
 
    // select scenario, if correct one given, by default simple scenarion is used.
    if (scenario == "larger")
    {
        satScenario = SatHelper::LARGER;
    }
    else if (scenario == "full")
    {
        satScenario = SatHelper::FULL;
    }
 
    // Set up user given parameters for on/off functionality.
    Config::SetDefault("ns3::OnOffApplication::PacketSize", UintegerValue(packetSize));
    Config::SetDefault("ns3::OnOffApplication::DataRate", StringValue(dataRate));
    Config::SetDefault("ns3::OnOffApplication::OnTime",
                       StringValue("ns3::ConstantRandomVariable[Constant=" + onTime + "]"));
    Config::SetDefault("ns3::OnOffApplication::OffTime",
                       StringValue("ns3::ConstantRandomVariable[Constant=" + offTime + "]"));
 
    // enable info logs
    LogComponentEnable("OnOffApplication", LOG_LEVEL_INFO);
    LogComponentEnable("PacketSink", LOG_LEVEL_INFO);
    LogComponentEnable("OnOff-example", LOG_LEVEL_INFO);
 
    // remove next line from comments to run real time simulation
    // GlobalValue::Bind ("SimulatorImplementationType", StringValue
    // ("ns3::RealtimeSimulatorImpl"));
 
    // create satellite helper with given scenario default=simple
 
    // Creating the reference system. Note, currently the satellite module supports
    // only one reference system, which is named as "Scenario72". The string is utilized
    // in mapping the scenario to the needed reference system configuration files. Arbitrary
    // scenario name results in fatal error.
    Ptr<SatHelper> helper = simulationHelper->CreateSatScenario(satScenario);
 
    // --- Create applications according to given user parameters
 
    // assert if sender is not valid
    NS_ASSERT_MSG(((sender == "gw") || (sender == "ut") || (sender == "both")),
                  "Sender argument invalid.");
 
    // in case of sender is GW or Both, create OnOff application to GW connected user
    // and Sink application to UT connected user
    if ((sender == "gw") || (sender == "both"))
    {
        simulationHelper->InstallTrafficModel(SimulationHelper::ONOFF,
                                              SimulationHelper::UDP,
                                              SimulationHelper::FWD_LINK,
                                              Seconds(1.0));
    }
 
    // in case of sender is UT or Both, create OnOff application to UT connected user
    // and Sink application to GW connected user
    if (sender == "ut" || sender == "both")
    {
        simulationHelper->InstallTrafficModel(SimulationHelper::ONOFF,
                                              SimulationHelper::UDP,
                                              SimulationHelper::RTN_LINK,
                                              Seconds(2.0));
    }
 
    // prompt info of the used parameters
    NS_LOG_INFO("--- sat-onoff-example ---");
    NS_LOG_INFO("  Scenario used: " << scenario);
    NS_LOG_INFO("  Sender: " << sender);
    NS_LOG_INFO("  PacketSize: " << packetSize);
    NS_LOG_INFO("  DataRate: " << dataRate);
    NS_LOG_INFO("  OnTime: " << onTime);
    NS_LOG_INFO("  OffTime: " << offTime);
    NS_LOG_INFO("  Duration: " << simDuration);
    NS_LOG_INFO("  ");
 
    // run simulation and finally destroy it
    simulationHelper->RunSimulation();
 
    return 0;
}