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

//

// Copyright (c) 2006 Georgia Tech Research Corporation

// All rights reserved.

//

// 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: George F. Riley<riley@ece.gatech.edu>

//

// George F. Riley, Georgia Tech, Fall 2006

#ifndef I_NODE_H

#define I_NODE_H

#include <vector>

#include "ns3/interface.h"

namespace ns3 {

class TraceContext;

class TraceResolver;

class NetDevice;

class Application;

/**

 *

 * This class holds together:

 *   - a list of NetDevice objects which represent the network interfaces

 *     Channel instances.

 *   - a list of Application objects which represent the userspace

 *     through the Socket API.

 *   - a node Id: a unique per-node identifier.

 *   - a system Id: a unique Id used for parallel simulations.

 *   - a trace resolver which can be used to connect user trace sinks

 *     to the node's trace sources.

 *

 */

{

public:

  static const InterfaceId iid;

  /**

   * \param context the trace context for the TraceResolver to create

   * \returns a newly-created TraceResolver. The caller takes

   *          ownership of the returned pointer.

   *

   * could be used directly by a user who needs access to very low-level

   * trace configuration.

   */

  TraceResolver *CreateTraceResolver (TraceContext const &context);

  /**

   * \returns the unique id of this node.

   * 

   * the NodeList. 

   */

  uint32_t GetId (void) const;

  /**

   * \returns the system id for parallel simulations associated

   *          to this node.

   */

  uint32_t GetSystemId (void) const;

  /**

   * \param device NetDevice to associate to this node.

   *          NetDevice.

   *

   * Associate this device to this node.

   * This method is called automatically from NetDevice::NetDevice

   * so the user has little reason to call this method himself.

   */

  uint32_t AddDevice (Ptr<NetDevice> device);

  /**

   * \param index the index of the requested NetDevice

   */

  Ptr<NetDevice> GetDevice (uint32_t index) const;

  /**

   * \returns the number of NetDevice instances associated

   */

  uint32_t GetNDevices (void) const;

  /**

   * \param application Application to associate to this node.

   *          of Application.

   *

   * automatically from Application::Application so the user

   * has little reasons to call this method directly.

   */

  uint32_t AddApplication (Ptr<Application> application);

  /**

   * \param index

   * \returns the application associated to this requested index

   */

  Ptr<Application> GetApplication (uint32_t index) const;

  /**

   */

  uint32_t GetNApplications (void) const;

protected:

  /**

   * Must be invoked by subclasses only.

   */

  /**

   * \param systemId a unique integer used for parallel simulations.

   *

   * Must be invoked by subclasses only.

   */

  /**

   * The dispose method. Subclasses must override this method

   * end of their own DoDispose method.

   */

  virtual void DoDispose (void);

private:

  /**

   * \param context the trace context

   * \returns a trace resolver to the user. The user must delete it.

   *

   * Subclasses must implement this method.

   */

  virtual TraceResolver *DoCreateTraceResolver (TraceContext const &context) = 0;

  /**

   *

   * Subclasses are expected to call NetDevice::SetReceiveCallback

   * at this point to setup the node's receive function for

   * the NetDevice packets.

   */

  virtual void DoAddDevice (Ptr<NetDevice> device) const = 0;

  uint32_t    m_sid;        // System id for this node

  std::vector<Ptr<NetDevice> > m_devices;

  std::vector<Ptr<Application> > m_applications;

};

} //namespace ns3

#endif /* I_NODE_H */