VCO.h

// SPDX-FileCopyrightText: 2026 Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include <vector>
 
#include <dpsim-models/SimSignalComp.h>
#include <dpsim-models/Task.h>
 
namespace CPS {
namespace Signal {
class VCO : public SimSignalComp, public SharedFactory<VCO> {
 
protected:
  Real mOmegaNom;
  Real mTimeStep;
 
public:
  const Attribute<Real>::Ptr mInputRef;
  const Attribute<Real>::Ptr mInputPrev;
  const Attribute<Real>::Ptr mInputCurr;
  const Attribute<Real>::Ptr mStatePrev;
  const Attribute<Real>::Ptr mStateCurr;
  const Attribute<Real>::Ptr mOutputPrev;
  const Attribute<Real>::Ptr mOutputCurr;
 
  VCO(String name, Logger::Level logLevel = Logger::Level::off);
  void setParameters(Real omegaNom);
  void setSimulationParameters(Real timestep);
  void setInitialValues(Real input_init, Real state_init, Real output_init);
  void signalPreStep(Real time, Int timeStepCount);
  void signalStep(Real time, Int timeStepCount);
  void signalAddPreStepDependencies(AttributeBase::List &prevStepDependencies,
                                    AttributeBase::List &attributeDependencies,
                                    AttributeBase::List &modifiedAttributes);
  void signalAddStepDependencies(AttributeBase::List &prevStepDependencies,
                                 AttributeBase::List &attributeDependencies,
                                 AttributeBase::List &modifiedAttributes);
 
  Task::List getTasks();
 
  class PreStep : public Task {
  public:
    PreStep(VCO &VCO) : Task(**VCO.mName + ".PreStep"), mVCO(VCO) {
      mVCO.signalAddPreStepDependencies(
          mPrevStepDependencies, mAttributeDependencies, mModifiedAttributes);
    }
    void execute(Real time, Int timeStepCount) {
      mVCO.signalPreStep(time, timeStepCount);
    };
 
  private:
    VCO &mVCO;
  };
 
  class Step : public Task {
  public:
    Step(VCO &VCO) : Task(**VCO.mName + ".Step"), mVCO(VCO) {
      mVCO.signalAddStepDependencies(
          mPrevStepDependencies, mAttributeDependencies, mModifiedAttributes);
    }
    void execute(Real time, Int timeStepCount) {
      mVCO.signalStep(time, timeStepCount);
    };
 
  private:
    VCO &mVCO;
  };
};
} // namespace Signal
} // namespace CPS