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

/*

 * 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

 */

// Define an object to create a star topology.

#ifndef CSMA_STAR_HELPER_H

#define CSMA_STAR_HELPER_H

#include <string>

#include "csma-helper.h"

#include "ipv4-address-helper.h"

#include "internet-stack-helper.h"

#include "ipv4-interface-container.h"

namespace ns3 {

/**

 *

 */

/**

 *

 * \brief A helper to make it easier to create a star topology

 * with Csma links

 */

class CsmaStarHelper

{

public:

  /**

   * Create a CsmaStarHelper in order to easily create

   * star topologies using Csma links

   *

   * \param numSpokes the number of links attached to 

   *        the hub node, creating a total of 

   *        numSpokes + 1 nodes

   *

   * \param csmaHelper the link helper for Csma links, 

   *        used to link nodes together

   */

  CsmaStarHelper (uint32_t numSpokes, 

                  CsmaHelper csmaHelper);

  ~CsmaStarHelper ();

public:

  /**

   * \returns a node pointer to the hub node in the

   *          star, i.e., the center node

   */

  Ptr<Node> GetHub () const;

  /**

   * \param i an index into the spokes of the star

   *

   * \returns a node pointer to the node at the indexed spoke

   */

  Ptr<Node> GetSpokeNode (uint32_t i) const;

  /**

   * \returns the net-device container which contains all of 

   *          the devices on the hub node

   */

  NetDeviceContainer GetHubDevices () const;

  /**

   * \returns the net-device container which contains all of 

   *          the spoke node devices

   */

  NetDeviceContainer GetSpokeDevices () const;

  /**

   * \param i index into the hub interfaces

   *

   * \returns Ipv4Address according to indexed hub interface

   */

  Ipv4Address GetHubIpv4Address (uint32_t i) const;

  /**

   * \param i index into the spoke interfaces

   *

   * \returns Ipv4Address according to indexed spoke interface

   */

  Ipv4Address GetSpokeIpv4Address (uint32_t i) const;

  /**

   * \returns the total number of spokes in the star

   */

  uint32_t SpokeCount () const;

  /**

   * \param stack an InternetStackHelper which is used to install 

   *              on every node in the star

   */

  void InstallStack (InternetStackHelper stack);

  /**

   * \param address an Ipv4AddressHelper which is used to install 

   *                Ipv4 addresses on all the node interfaces in 

   *                the star

   */

  void AssignIpv4Addresses (Ipv4AddressHelper address);

private:

  NodeContainer m_hub;

  NetDeviceContainer m_hubDevices;

  NodeContainer m_spokes;

  NetDeviceContainer m_spokeDevices;

  Ipv4InterfaceContainer m_hubInterfaces;

  Ipv4InterfaceContainer m_spokeInterfaces;

};

} // namespace ns3

#endif /* CSMA_STAR_HELPER_H */