DataProvider.h

Go to the documentation of this file.

/*
 * DataProvider.h
 *
 *  Created on: 08 Feb 2017
 *      Author: Nicola Mori
 */

#ifndef DATAPROVIDER_H_
#define DATAPROVIDER_H_

#include "core/Configurable.h"
#include "core/Info.h"
#include "core/ObjectMap.h"
#include "data/ObjectCategory.h"
#include "data/ObjectProducer.h"

#include <string>

namespace EA {

class DataProvider : public Info, public Configurable, public ObjectProducer {

public:
  DataProvider(const std::string &name, const std::string &dataSource) : Info(name), _dataSource(dataSource) {}

  virtual ~DataProvider() = default;

private:
  virtual bool Connect() { return true; }

  virtual bool Disconnect() { return true; }

  virtual RetrievalResult GetObject(const std::string &name, ObjectCategory category, ObjectWrapper &wrapper,
                                    std::string &actualName) {
    if (_disabled) {
      return DataProvider::GetObject(name, category, wrapper);
    } else {
      return GetObject(name, category, wrapper);
    }
  }

  virtual RetrievalResult GetObject(const std::string &name, ObjectCategory category, ObjectWrapper &wrapper) {
    return RetrievalResult::NOTFOUND;
  }

  virtual bool SetCurrentEvent(unsigned int event, std::vector<std::string> &notValidGlobalObjects) {
    if (_disabled) {
      return DataProvider::SetCurrentEvent(event);
    } else {
      return SetCurrentEvent(event);
    }
  }

  virtual bool SetCurrentEvent(unsigned int event) { return true; }

  virtual bool SetCurrentPass(unsigned int pass, unsigned int iteration) { return true; }

public:
  const std::string &GetDataSource() { return _dataSource; }

  bool IsDisabled() { return _disabled; }

  bool SetDisabled(bool disabled = true);

  RetrievalResult RetrieveObject(const std::string &name, ObjectCategory category, ObjectWrapper &wrapper,
                                 std::string &actualName) {
    if (_disabled) {
      return DataProvider::GetObject(name, category, wrapper, actualName); // Static call to base class implementation
    } else {
      return GetObject(name, category, wrapper, actualName); // Polymorphic call to derived class override
    }
  }

  virtual bool IsEventAvailable(unsigned int event) { return true; }

  bool ConnectSource();

  bool DisconnectSource();

  bool SetEvent(unsigned int event, std::vector<std::string> &notValidGlobalObjects);

  bool SetPass(unsigned int pass, unsigned int iteration);

private:
  std::string _dataSource; 
  bool _disabled = false;  
};

} // namespace EA

#include "plugin/FactoryMacros.h"
#define RegisterDataProvider(className)                                                                                \
  RegisterClass(EA::DataProvider, className, const std::string &, const std::string &)
#define RegisterNSDataProvider(namespace, className)                                                                   \
  RegisterClassAs(EA::DataProvider, className, #namespace "::" #className, const std::string &, const std::string &)

#endif /* DATAPROVIDER_H_ */