ComponentProvider.h

Go to the documentation of this file.

#pragma once
 
#include <omnetpp.h>
 
#include "DefaultComponentProviderStrategy.h"
#include "IComponentProviderStrategy.h"
#include "modules/Logger/LoggerModule.h"
#include "modules/QRSA/QRSA.h"
#include "modules/common_types.h"
#include "utils.h"
 
namespace quisp::utils {
 
class ComponentProvider {
 public:
  ComponentProvider(omnetpp::cModule *_module);
 
  cModule *getQNode();
  cModule *getNode();
  int getNodeAddr();
  cModule *getNeighborNode(cModule *qnic);
  bool isQNodeType(const cModuleType *const type);
  bool isBSANodeType(const cModuleType *const type);
  bool isEPPSNodeType(const cModuleType *const type);
  IStationaryQubit *getStationaryQubit(modules::qrsa::IQubitRecord *const qubit_record);
  IStationaryQubit *getStationaryQubit(int qnic_index, int qubit_index, QNIC_type qnic_type);
  cModule *getQNIC(int qnic_index, QNIC_type qnic_type);
  int getNumQubits(int qnic_index, QNIC_type qnic_type);
  IRoutingDaemon *getRoutingDaemon();
  IHardwareMonitor *getHardwareMonitor();
  IRealTimeController *getRealTimeController();
  IQuantumBackend *getQuantumBackend();
  ILogger *getLogger();
  cTopology *getTopologyForRoutingDaemon(const cModule *const rd_module);
  cTopology *getTopologyForRouter();
  const std::unordered_map<int, int> getEndNodeWeightMapForApplication(std::string node_type);
  // when a this class instantiated, a strategy class instantiation may fail because
  // the strategy class may depend on other modules instantiated by OMNeT++'s NED file.
  // So this method is for delaying to instantiate the strategy class.
  // And also we can inject a strategy for unit testing.
  void setStrategy(std::unique_ptr<IComponentProviderStrategy> _strategy);
 
  // an owner module of this class.
  // strategy class will access to other modules by the module.
  omnetpp::cModule *module;
 
 private:
  // An actual strategy.
  // This will be instantiated when it is needed through ensureStrategy method.
  // It will be deleted automatically when ComponentProvider's deconstructor called.
  std::unique_ptr<IComponentProviderStrategy> strategy = nullptr;
 
  SharedResource *getSharedResource();
 
  // before calling strategy class, this internal method ensure that
  // the strategy class instance exists.
  // if there's no strategy, this method uses DefaultComponentProviderStrategy.
  void ensureStrategy();
};
 
}  // namespace quisp::utils