/*
 * Copyright (c) 2008 INRIA
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 */
#ifndef NET_DEVICE_CONTAINER_H
#define NET_DEVICE_CONTAINER_H

#include "ns3/net-device.h"

#include <stdint.h>
#include <vector>

namespace ns3
{

/**
 * @brief holds a vector of ns3::NetDevice pointers
 *
 * Typically ns-3 NetDevices are installed on nodes using a net device
 * helper.  The helper Install method takes a NodeContainer which holds
 * some number of Ptr<Node>.  For each of the Nodes in the NodeContainer
 * the helper will instantiate a net device, add a MAC address and a queue
 * to the device and install it to the node.  For each of the devices, the
 * helper also adds the device into a Container for later use by the caller.
 * This is that container used to hold the Ptr<NetDevice> which are
 * instantiated by the device helper.
 */
class NetDeviceContainer
{
  public:
    /// NetDevice container iterator
    typedef std::vector<Ptr<NetDevice>>::const_iterator Iterator;

    /**
     * Create an empty NetDeviceContainer.
     */
    NetDeviceContainer();

    /**
     * @param dev a device to add to the container
     *
     * Create a NetDeviceContainer with exactly one net device that has previously
     * been instantiated
     */
    NetDeviceContainer(Ptr<NetDevice> dev);

    /**
     * Create a NetDeviceContainer with exactly one device which has been
     * previously instantiated and assigned a name using the Object name
     * service.  This NetDevice is specified by its assigned name.
     *
     * @param devName The name of the device to add to the container
     *
     * Create a NetDeviceContainer with exactly one device
     */
    NetDeviceContainer(std::string devName);

    /**
     * @param a a device container
     * @param b another device container
     *
     * Create a device container which is a concatenation of the two input
     * NetDeviceContainers.
     *
     * @note A frequently seen idiom that uses these constructors involves the
     * implicit conversion by constructor of Ptr<NetDevice>.  When used, two
     * Ptr<NetDevice> will be passed to this constructor instead of NetDeviceContainer&.
     * C++ will notice the implicit conversion path that goes through the
     * NetDeviceContainer (Ptr<NetDevice> dev) constructor above.  Using this conversion
     * one may provide optionally provide arguments of Ptr<NetDevice> to these
     * constructors.
     */
    NetDeviceContainer(const NetDeviceContainer& a, const NetDeviceContainer& b);

    /**
     * @brief Get an iterator which refers to the first NetDevice in the
     * container.
     *
     * NetDevices can be retrieved from the container in two ways.  First,
     * directly by an index into the container, and second, using an iterator.
     * This method is used in the iterator method and is typically used in a
     * for-loop to run through the NetDevices
     *
     * @code
     *   for (auto i = container.Begin(); i != container.End(); ++i)
     *   {
     *       (*i)->method(); // some NetDevice method
     *   }
     * @endcode
     *
     * @returns an iterator which refers to the first NetDevice in the container.
     */
    Iterator Begin() const;

    /**
     * @brief Get an iterator which indicates past-the-last NetDevice in the
     * container.
     *
     * NetDevices can be retrieved from the container in two ways.  First,
     * directly by an index into the container, and second, using an iterator.
     * This method is used in the iterator method and is typically used in a
     * for-loop to run through the NetDevices
     *
     * @code
     *   for (auto i = container.Begin(); i != container.End(); ++i)
     *   {
     *       (*i)->method(); // some NetDevice method
     *   }
     * @endcode
     *
     * @returns an iterator which indicates an ending condition for a loop.
     */
    Iterator End() const;

    /**
     * @brief Get the number of Ptr<NetDevice> stored in this container.
     *
     * NetDevices can be retrieved from the container in two ways.  First,
     * directly by an index into the container, and second, using an iterator.
     * This method is used in the direct method and is typically used to
     * define an ending condition in a for-loop that runs through the stored
     * NetDevices
     *
     * @code
     *   uint32_t nDevices = container.GetN ();
     *   for (uint32_t i = 0 i < nDevices; ++i)
     *     {
     *       Ptr<NetDevice> p = container.Get (i)
     *       i->method ();  // some NetDevice method
     *     }
     * @endcode
     *
     * @returns the number of Ptr<NetDevice> stored in this container.
     */
    uint32_t GetN() const;

    /**
     * @brief Get the Ptr<NetDevice> stored in this container at a given
     * index.
     *
     * NetDevices can be retrieved from the container in two ways.  First,
     * directly by an index into the container, and second, using an iterator.
     * This method is used in the direct method and is used to retrieve the
     * indexed Ptr<NetDevice>.
     *
     * @code
     *   uint32_t nDevices = container.GetN ();
     *   for (uint32_t i = 0 i < nDevices; ++i)
     *     {
     *       Ptr<NetDevice> p = container.Get (i)
     *       i->method ();  // some NetDevice method
     *     }
     * @endcode
     *
     * @param i the index of the requested device pointer.
     * @returns the requested device pointer.
     * @hidecaller
     */
    Ptr<NetDevice> Get(uint32_t i) const;

    /**
     * @brief Append the contents of another NetDeviceContainer to the end of
     * this container.
     *
     * @param other The NetDeviceContainer to append.
     * @hidecaller
     */
    void Add(NetDeviceContainer other);

    /**
     * @brief Append a single Ptr<NetDevice> to this container.
     *
     * @param device The Ptr<NetDevice> to append.
     */
    void Add(Ptr<NetDevice> device);

    /**
     * @brief Append to this container the single Ptr<NetDevice> referred to
     * via its object name service registered name.
     *
     * @param deviceName The name of the NetDevice Object to add to the container.
     */
    void Add(std::string deviceName);

  private:
    std::vector<Ptr<NetDevice>> m_devices; //!< NetDevices smart pointers
};

} // namespace ns3

#endif /* NET_DEVICE_CONTAINER_H */
