TopologicalPowerComp.h

/* Copyright 2017-2021 Institute for Automation of Complex Power Systems,
 *                     EONERC, RWTH Aachen University
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *********************************************************************************/
 
#pragma once
 
#include <iostream>
#include <memory>
#include <typeinfo>
#include <vector>
 
#include <dpsim-models/IdentifiedObject.h>
#include <dpsim-models/Logger.h>
#include <dpsim-models/TopologicalNode.h>
#include <dpsim-models/TopologicalTerminal.h>
 
namespace CPS {
class TopologicalPowerComp : public IdentifiedObject {
public:
  enum Behaviour { Initialization, MNASimulation, PFSimulation };
 
protected:
  UInt mNumTerminals = 0;
  UInt mNumVirtualNodes = 0;
  Logger::Log mSLog;
  Logger::Level mLogLevel;
  Behaviour mBehaviour = Behaviour::MNASimulation;
  bool mParametersSet = false;
 
public:
  typedef std::shared_ptr<TopologicalPowerComp> Ptr;
  typedef std::vector<Ptr> List;

  TopologicalPowerComp(String uid, String name,
                       Logger::Level logLevel = Logger::Level::off)
      : IdentifiedObject(uid, name),
        /* We also want to set the CLI loglevel according to the logLevel
         * std::max(Logger::Level::info, logLevel). But because of excessive
         * logging to Level::info that is currently infeasible. */
        mSLog(Logger::get(name, logLevel, Logger::Level::warn)),
        mLogLevel(logLevel) {}

  TopologicalPowerComp(String name, Logger::Level logLevel = Logger::Level::off)
      : TopologicalPowerComp(name, name, logLevel) {}

  virtual ~TopologicalPowerComp() {}

  virtual TopologicalNode::List topologicalNodes() = 0;
  virtual TopologicalTerminal::List topologicalTerminals() = 0;
  void setBehaviour(Behaviour behaviour) {
    mBehaviour = behaviour;
    if (mBehaviour == Behaviour::Initialization)
      SPDLOG_LOGGER_INFO(mSLog, "Set component behaviour to Initialization");
    else if (mBehaviour == Behaviour::PFSimulation)
      SPDLOG_LOGGER_INFO(mSLog, "Set component behaviour to PFSimulation");
    else if (mBehaviour == Behaviour::MNASimulation)
      SPDLOG_LOGGER_INFO(mSLog, "Set component behaviour to MNASimulation");
    else
      SPDLOG_LOGGER_WARN(mSLog,
                         "Set component behaviour not fully supported yet");
  }
};
} // namespace CPS