/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2009 IITP RAS

 *

 * 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

 *

 * Authors: Pavel Boyko <boyko@iitp.ru>

 */

#ifndef TCREGRESSIONTEST_H_

#define TCREGRESSIONTEST_H_

#include "ns3/test.h"

#include "ns3/nstime.h"

#include "ns3/node-container.h"

namespace ns3

{

namespace olsr

{

/**

 * \ingroup olsr

 * \brief Less trivial test of OLSR Topology Control message generation

 * 

 * This test creates 3 WiFi stations with chain topology and runs OLSR without any extra traffic. 

 * It is expected that only second station will send TC messages.

 * 

 * Expected trace (20 seconds, note random b-cast jitter):

   \verbatim

         |<------|------>|              HELLO (empty) src = 10.1.1.2

         |       |<------|------>       HELLO (empty) src = 10.1.1.3

  <------|------>|       |              HELLO (empty) src = 10.1.1.1

  <------|------>|       |              HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.2) src = 10.1.1.3

         |<------|------>|              HELLO (Link Type: Asymmetric, Neighbor: 10.1.1.3; Link Type: Asymmetric, Neighbor: 10.1.1.1) src = 10.1.1.2

  <------|------>|       |              HELLO (Link Type: Symmetric, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: Symmetric, Neighbor: 10.1.1.2) src = 10.1.1.3

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

  <------|------>|       |              HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.1

         |       |<------|------>       HELLO (Link Type: MPR Link, Neighbor: 10.1.1.2) src = 10.1.1.3

   \endverbatim 

 */

class TcRegressionTest : public TestCase

{

public:

  TcRegressionTest(); 

  ~TcRegressionTest();

private:

  /// Unique PCAP files prefix for this test

  static const char * const PREFIX;

  /// Total simulation time

  const Time m_time;

  /// Distance between nodes in meters, 0.8 of RX range is recommended

  const double m_step;

  /// Create & configure test network

  void CreateNodes ();

  /// Compare traces with reference ones

  void CheckResults ();

  /// Go

  void DoRun ();

};

}

}

#endif /* TCREGRESSIONTEST_H_ */