helics  3.5.1
Public Member Functions | List of all members
helics::apps::SineGenerator Class Reference

#include <SignalGenerators.hpp>

+ Inheritance diagram for helics::apps::SineGenerator:

Public Member Functions

 SineGenerator (std::string_view name)
 
virtual void set (std::string_view parameter, double val) override
 
virtual defV generate (Time signalTime) override
 
- Public Member Functions inherited from helics::apps::SignalGenerator
 SignalGenerator (std::string_view name)
 
virtual void setString (std::string_view parameter, std::string_view val)
 
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 sinusoidal signal

Member Function Documentation

◆ generate()

defV helics::apps::SineGenerator::generate ( Time  signalTime)
overridevirtual

generate a new value at time signalTime

Returns
a value and a defV object

Implements helics::apps::SignalGenerator.

◆ set()

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

set a numerical parameter

Reimplemented from helics::apps::SignalGenerator.

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


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