CPS::Signal::SineWaveGenerator Class Reference

Model to generate sinusoidal signals. More...

#include <SineWaveGenerator.h>

Inheritance diagram for CPS::Signal::SineWaveGenerator:

Collaboration diagram for CPS::Signal::SineWaveGenerator:

Public Member Functions
	SineWaveGenerator (String name, Logger::Level logLevel=Logger::Level::off)
	init the identified object
void	setParameters (Complex initialPhasor, Real frequency=0.0)
	set the source's parameters
void	step (Real time)
	implementation of inherited method step to update and return the current signal value
Public Member Functions inherited from CPS::Signal::SignalGenerator
	SignalGenerator (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	SignalGenerator (String name, Logger::Level logLevel=Logger::Level::off)
Complex	getSignal ()
	returns current signal value without updating it
Public Member Functions inherited from CPS::SimSignalComp
	SimSignalComp (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	SimSignalComp (String name, Logger::Level logLevel=Logger::Level::off)
virtual	~SimSignalComp ()
virtual void	initialize (Real timeStep)
virtual void	initialize (Real omega, Real timeStep)
virtual Task::List	getTasks ()
void	setBehaviour (Behaviour behaviour)
	Set behavior of component, e.g. initialization.
Public Member Functions inherited from CPS::TopologicalSignalComp
	TopologicalSignalComp (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes UID, name and log level.
	TopologicalSignalComp (String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes name and log level and sets the UID to name as well.
virtual	~TopologicalSignalComp ()
Public Member Functions inherited from CPS::IdentifiedObject
	IdentifiedObject ()
	IdentifiedObject (const String &uid, const String &name)
	IdentifiedObject (const String &name)
virtual	~IdentifiedObject ()=default
AttributeBase::Ptr	attribute (const String &name) const
	Return pointer to an attribute.
template<typename T>
Attribute< T >::Ptr	attributeTyped (const String &name) const
	Return pointer to an attribute.
const AttributeBase::Map &	attributes () const
String	name ()
String	uid ()
	Returns unique id.
String	type ()
	Get component type (cross-platform)
virtual String	description ()

Public Attributes
const Attribute< Complex >::Ptr	mVoltageRef
Public Attributes inherited from CPS::Signal::SignalGenerator
const CPS::Attribute< Complex >::Ptr	mSigOut
const CPS::Attribute< Real >::Ptr	mFreq
Public Attributes inherited from CPS::IdentifiedObject
const Attribute< String >::Ptr	mName
	Human readable name.
const Attribute< String >::Ptr	mUID
	Unique identifier.

Additional Inherited Members
Public Types inherited from CPS::Signal::SignalGenerator
typedef std::shared_ptr< SignalGenerator >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::SimSignalComp
enum	Behaviour { Initialization , Simulation }
typedef std::shared_ptr< SimSignalComp >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::TopologicalSignalComp
typedef std::shared_ptr< TopologicalSignalComp >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::IdentifiedObject
typedef std::shared_ptr< IdentifiedObject >	Ptr
typedef std::vector< Ptr >	List
Static Public Member Functions inherited from SharedFactory< SineWaveGenerator >
static std::shared_ptr< SineWaveGenerator >	make (Args &&...args)
Protected Attributes inherited from CPS::SimSignalComp
Bool	mBehaviour = Behaviour::Simulation
Protected Attributes inherited from CPS::TopologicalSignalComp
Logger::Log	mSLog
	Component logger.
Logger::Level	mLogLevel
	Component logger control for internal variables.
Protected Attributes inherited from CPS::IdentifiedObject
AttributeList::Ptr	mAttributes = AttributeList::make()
	Attribute List.

Detailed Description

Model to generate sinusoidal signals.

Inherits from the abstract SignalGenerator class. The generated signal must be characterised by its initial complex phasor and its frequency.

Definition at line 19 of file SineWaveGenerator.h.

Constructor & Destructor Documentation

SineWaveGenerator()

Signal::SineWaveGenerator::SineWaveGenerator	(	String	name,
		Logger::Level	logLevel = Logger::Level::off )

init the identified object

Definition at line 13 of file SineWaveGenerator.cpp.

Member Function Documentation

setParameters()

void Signal::SineWaveGenerator::setParameters	(	Complex	initialPhasor,
		Real	frequency = 0.0 )

set the source's parameters

Definition at line 20 of file SineWaveGenerator.cpp.

step()

void Signal::SineWaveGenerator::step ( Real time )

virtual

implementation of inherited method step to update and return the current signal value

Implements CPS::Signal::SignalGenerator.

Definition at line 36 of file SineWaveGenerator.cpp.

Member Data Documentation

mVoltageRef

const Attribute<Complex>::Ptr CPS::Signal::SineWaveGenerator::mVoltageRef

Definition at line 27 of file SineWaveGenerator.h.

---

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

• /__w/dpsim/dpsim/dpsim-models/include/dpsim-models/Signal/SineWaveGenerator.h
• /__w/dpsim/dpsim/dpsim-models/src/Signal/SineWaveGenerator.cpp