satellite-scenario-creation.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd
 *
 * 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/core-module.h"
#include "ns3/satellite-env-variables.h"
#include "ns3/satellite-helper.h"
#include "ns3/satellite-id-mapper.h"
#include "ns3/satellite-topology.h"
#include "ns3/simulator.h"
#include "ns3/singleton.h"
#include "ns3/string.h"
#include "ns3/test.h"
 
using namespace ns3;

class ScenarioCreationSimple : public TestCase
{
  public:
    ScenarioCreationSimple();
    virtual ~ScenarioCreationSimple();
 
  private:
    virtual void DoRun(void);
};
 
// Add some help text to this case to describe what it is intended to test
ScenarioCreationSimple::ScenarioCreationSimple()
    : TestCase("'Scenario Creation, Simple' case tests successful creation of Simple test scenario")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
ScenarioCreationSimple::~ScenarioCreationSimple()
{
}
 
//
// ScenarioCreationSimple TestCase implementation
//
void
ScenarioCreationSimple::DoRun(void)
{
    // Reset singletons
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-scenario-creation",
                                                       "simple-scenario",
                                                       true);
 
    // Create simple scenario
 
    // Creating the reference system.
    Ptr<SatHelper> helper = CreateObject<SatHelper>(
        SatEnvVariables::GetInstance()->LocateDataDirectory() + "/scenarios/geo-33E");
 
    // Enable creation traces
    Config::SetDefault("ns3::SatHelper::ScenarioCreationTraceEnabled", BooleanValue(true));
 
    helper->CreatePredefinedScenario(SatHelper::SIMPLE);
 
    // check results what can be done at this level. More checking done in module level with traces
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetGwUserNodes().GetN(),
                          1,
                          "GW User count is not what expected!");
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetNUtUserNodes(),
                          1,
                          "UT User count is not what expected!");
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    Simulator::Destroy();
}

class ScenarioCreationLarger : public TestCase
{
  public:
    ScenarioCreationLarger();
    virtual ~ScenarioCreationLarger();
 
  private:
    virtual void DoRun(void);
};
 
// Add some help text to this case to describe what it is intended to test
ScenarioCreationLarger::ScenarioCreationLarger()
    : TestCase("'Scenario Creation, Larger' case tests successful creation of Larger test scenario")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
ScenarioCreationLarger::~ScenarioCreationLarger()
{
}
 
//
// ScenarioCreationLarger TestCase implementation
//
void
ScenarioCreationLarger::DoRun(void)
{
    // Reset singletons
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-scenario-creation",
                                                       "larger-scenario",
                                                       true);
 
    // Create larger scenario
 
    // Creating the reference system.
    Ptr<SatHelper> helper = CreateObject<SatHelper>(
        SatEnvVariables::GetInstance()->LocateDataDirectory() + "/scenarios/geo-33E");
 
    // Enable creation traces
    Config::SetDefault("ns3::SatHelper::ScenarioCreationTraceEnabled", BooleanValue(true));
 
    helper->CreatePredefinedScenario(SatHelper::LARGER);
 
    // check results what can be done at this level. More checking done in module level with traces
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetGwUserNodes().GetN(),
                          1,
                          "GW User count is not what expected!");
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetNUtUserNodes(),
                          5,
                          "UT User count is not what expected!");
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    Simulator::Destroy();
}

class ScenarioCreationFull : public TestCase
{
  public:
    ScenarioCreationFull();
    virtual ~ScenarioCreationFull();
 
  private:
    virtual void DoRun(void);
};
 
// Add some help text to this case to describe what it is intended to test
ScenarioCreationFull::ScenarioCreationFull()
    : TestCase("'Scenario Creation, Full' case tests successful creation of Full test scenario")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
ScenarioCreationFull::~ScenarioCreationFull()
{
}
 
//
// ScenarioCreationFull TestCase implementation
//
void
ScenarioCreationFull::DoRun(void)
{
    // Reset singletons
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-scenario-creation",
                                                       "full-scenario",
                                                       true);
 
    // Create full scenario
 
    // Creating the reference system.
    Ptr<SatHelper> helper = CreateObject<SatHelper>(
        SatEnvVariables::GetInstance()->LocateDataDirectory() + "/scenarios/geo-33E");
 
    // Enable creation traces
    Config::SetDefault("ns3::SatHelper::ScenarioCreationTraceEnabled", BooleanValue(true));
 
    helper->CreatePredefinedScenario(SatHelper::FULL);
 
    // check results what can be done at this level. More checking done in module level with traces
    // reference system includes 98 beams and we create three UTs with three users per UT in full
    // scenario and five GW users
 
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetGwUserNodes().GetN(),
                          5,
                          "GW User count is not what expected!");
    // NS_TEST_ASSERT_MSG_EQ (Singleton<SatTopology>::Get()->GetNUtUserNodes(), 98*3*3, "UT User
    // count is not what expected!");
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetNUtUserNodes(),
                          72 * 3 * 3,
                          "UT User count is not what expected!");
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    Simulator::Destroy();
}

class ScenarioCreationUser : public TestCase
{
  public:
    ScenarioCreationUser();
    virtual ~ScenarioCreationUser();
 
  private:
    virtual void DoRun(void);
};
 
// Add some help text to this case to describe what it is intended to test
ScenarioCreationUser::ScenarioCreationUser()
    : TestCase("'Scenario Creation, User defined' case tests successful creation of User defined "
               "test scenario")
{
}
 
// This destructor does nothing but we include it as a reminder that
// the test case should clean up after itself
ScenarioCreationUser::~ScenarioCreationUser()
{
}
 
//
// ScenarioCreationUser TestCase implementation
//
void
ScenarioCreationUser::DoRun(void)
{
    // Reset singletons
    Singleton<SatIdMapper>::Get()->Reset();
 
    // Set simulation output details
    SatEnvVariables::GetInstance()->DoInitialize();
    SatEnvVariables::GetInstance()->SetOutputVariables("test-scenario-creation",
                                                       "user-scenario",
                                                       true);
 
    // Create user scenario
 
    // Creating the reference system.
    Ptr<SatHelper> helper = CreateObject<SatHelper>(
        SatEnvVariables::GetInstance()->LocateDataDirectory() + "/scenarios/geo-33E");
    SatBeamUserInfo beamInfo = SatBeamUserInfo(1, 1);
    std::map<std::pair<uint32_t, uint32_t>, SatBeamUserInfo> beamMap;
    beamMap[std::make_pair(0, 8)] = beamInfo;
    beamMap[std::make_pair(0, 3)] = beamInfo;
    beamInfo.AppendUt(2);
    beamMap[std::make_pair(0, 2)] = beamInfo;
 
    // Enable creation traces
    Config::SetDefault("ns3::SatHelper::ScenarioCreationTraceEnabled", BooleanValue(true));
 
    helper->CreateUserDefinedScenario(beamMap);
 
    // check results what can be done at this level. More checking done in module level with traces
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetGwUserNodes().GetN(),
                          5,
                          "GW User count is not what expected!");
    NS_TEST_ASSERT_MSG_EQ(Singleton<SatTopology>::Get()->GetNUtUserNodes(),
                          5,
                          "UT User count is not what expected!");
 
    SatEnvVariables::GetInstance()->DoDispose();
 
    Simulator::Destroy();
}
 
// The TestSuite class names the TestSuite as sat-scenario-creation, identifies what type of
// TestSuite (Type::SYSTEM), and enables the TestCases to be run. Typically, only the constructor
// for this class must be defined
//
class ScenarioCreationTestSuite : public TestSuite
{
  public:
    ScenarioCreationTestSuite();
};
 
ScenarioCreationTestSuite::ScenarioCreationTestSuite()
    : TestSuite("sat-scenario-creation", Type::SYSTEM)
{
    // add ScenarioCreationSimple case to suite sat-scenario-creation
    AddTestCase(new ScenarioCreationSimple, TestCase::Duration::QUICK);
 
    // add ScenarioCreationLarger case to suite sat-scenario-creation
    AddTestCase(new ScenarioCreationLarger, TestCase::Duration::QUICK);
 
    // add ScenarioCreationFull case to suite sat-scenario-creation
    AddTestCase(new ScenarioCreationFull, TestCase::Duration::QUICK);
 
    // add ScenarioCreationUser case to suite sat-scenario-creation
    AddTestCase(new ScenarioCreationUser, TestCase::Duration::QUICK);
}
 
// Allocate an instance of this TestSuite
static ScenarioCreationTestSuite scenarioCreationTestSuite;