helics::apps::PhasorGenerator Class Reference

#include <SignalGenerators.hpp>

Inheritance diagram for helics::apps::PhasorGenerator:

Public Member Functions
	PhasorGenerator (std::string_view name)
virtual void	set (std::string_view parameter, double val) override
void	set (std::string_view parameter, std::complex< double > val)
virtual void	setString (std::string_view parameter, std::string_view val) override
virtual defV	generate (Time signalTime) override
Public Member Functions inherited from helics::apps::SignalGenerator
	SignalGenerator (std::string_view name)
void	setTime (Time indexTime)
const std::string &	getName ()

Additional Inherited Members
Protected Attributes inherited from helics::apps::SignalGenerator
Time	lastTime {timeZero}
Time	keyTime {timeZero}
std::string	mName

Detailed Description

generate a rotating phasor

this is a coupled sinusoidal oscillator

Member Function Documentation

generate()

defV helics::apps::PhasorGenerator::generate ( Time  signalTime )

overridevirtual

generate a new value at time signalTime

Returns

a value and a defV object

Implements helics::apps::SignalGenerator.

set() [1/2]

void helics::apps::PhasorGenerator::set ( std::string_view  parameter, double  val  )

overridevirtual

set a numerical parameter

Reimplemented from helics::apps::SignalGenerator.

References helics::apps::SignalGenerator::set().

Referenced by setString().

set() [2/2]

void helics::apps::PhasorGenerator::set	(	std::string_view	parameter,
		std::complex< double >	val
	)

set overload for a complex parameter

setString()

void helics::apps::PhasorGenerator::setString ( std::string_view  parameter, std::string_view  val  )

overridevirtual

set a string parameter

Reimplemented from helics::apps::SignalGenerator.

References helics::helicsGetComplex(), set(), and helics::apps::SignalGenerator::setString().

---

The documentation for this class was generated from the following files:

• SignalGenerators.hpp
• SignalGenerators.cpp