qkd-control-container.h

Go to the documentation of this file.

/*
 * Copyright(c) 2020 DOTFEESA www.tk.etf.unsa.ba
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 *
 *
 * Author: Miralem Mehic <miralem.mehic@ieee.org>
 */
 
#ifndef QKD_CONTROL_CONTAINER_H
#define QKD_CONTROL_CONTAINER_H
 
#include <stdint.h>
#include <vector>
#include "ns3/qkd-control.h"
 
namespace ns3 {
 
/**
 * @ingroup QKD
 *
 * @brief holds a vector of std::pair of Ptr<QKDControl> and interface index.
 *
 * Typically ns-3 QKDControls are installed on nodes using an QKD
 * helper.
 *
 * @see QKDControl
 */
class QKDControlContainer
{
public:
  /**
   * @brief Container Const Iterator for pairs of QKDControl smart pointer / Interface Index.
   */
  typedef std::vector<std::pair<Ptr<QKDControl>, uint32_t> >::const_iterator Iterator;
 
  /**
   * Create an empty QKDControlContainer.
   */
  QKDControlContainer();
 
  /**
   * Concatenate the entries in the other container with ours.
   * @param other container
   */
  void Add(const QKDControlContainer& other);
 
  /**
   * @brief Get an iterator which refers to the first pair in the
   * container.
   *
   * Pairs 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 pairs
   *
   * @code
   *   QKDControlContainer::Iterator i;
   *   for(i = container.Begin(); i != container.End(); ++i)
   *     {
   *       std::pair<Ptr<QKDControl>, uint32_t> pair = *i;
   *       method(pair.first, pair.second);  // use the pair
   *     }
   * @endcode
   *
   * @returns an iterator which refers to the first pair in the container.
   */
  Iterator Begin() const;
 
  /**
   * @brief Get an iterator which indicates past-the-last Node in the
   * container.
   *
   * Nodes 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 Nodes
   *
   * @code
   *   NodeContainer::Iterator i;
   *   for(i = container.Begin(); i != container.End(); ++i)
   *     {
   *       std::pair<Ptr<QKDControl>, uint32_t> pair = *i;
   *       method(pair.first, pair.second);  // use the pair
   *     }
   * @endcode
   *
   * @returns an iterator which indicates an ending condition for a loop.
   */
  Iterator End() const;
 
  /**
   * @returns the number of Ptr<QKDControl> and interface pairs stored in this
   * QKDControlContainer.
   *
   * Pairs 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
   * Nodes
   *
   * @code
   *   uint32_t nNodes = container.GetN();
   *   for(uint32_t i = 0 i < nNodes; ++i)
   *     {
   *       std::pair<Ptr<QKDControl>, uint32_t> pair = container.Get(i);
   *       method(pair.first, pair.second);  // use the pair
   *     }
   * @endcode
   *
   * @returns the number of Ptr<Node> stored in this container.
   */
  uint32_t GetN() const;
 
  /**
   * Manually add an entry to the container consisting of a previously composed
   * entry std::pair.
   *
   * @param ipInterfacePair the pair of a pointer to Ipv4 object and interface index of the Ipv4Interface to add to the container
   */
  void Add(Ptr<QKDControl>, uint32_t ipInterfacePair);
 
  /**
   * Manually add an entry to the container consisting of a previously composed
   * entry std::pair.
   *
   * @param ipInterfacePair the pair of a pointer to Ipv4 object and interface index of the Ipv4Interface to add to the container
   */
  void Add(std::pair<Ptr<QKDControl>, uint32_t> ipInterfacePair);
 
  /**
   * Get the std::pair of an Ptr<QKDControl> and interface stored at the location
   * specified by the index.
   *
   * @param i the index of the container entry to retrieve.
   * @return the std::pair of a Ptr<QKDControl> and an interface index
   *
   */
  std::pair<Ptr<QKDControl>, uint32_t> Get(uint32_t i) const;
 
private:
  /**
   * @brief Container for pairs of QKDControl smart pointer / Interface Index.
   */
  typedef std::vector<std::pair<Ptr<QKDControl>,uint32_t> > InterfaceVector;
 
  /**
   * @brief List of QKD Encryptors and interfaces index.
   */
  InterfaceVector m_list;
};
 
} // namespace ns3
 
#endif /* QKD_CONTROL_CONTAINER_H */