CPS::Signal::SignalGenerator Class Reference

Model to generate generic signals. More...

#include <SignalGenerator.h>

Inheritance diagram for CPS::Signal::SignalGenerator:

Collaboration diagram for CPS::Signal::SignalGenerator:

Public Types
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

Public Member Functions
	SignalGenerator (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	SignalGenerator (String name, Logger::Level logLevel=Logger::Level::off)
virtual void	step (Real time)=0
	updates current signal
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 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.
Public Member Functions inherited from CPS::IdentifiedObject
	IdentifiedObject (const String &uid, const String &name)
	IdentifiedObject (const String &name)
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 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
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 generic signals.

Abstract model to generate different types of signals. Acts as a base class for more specific signal generator classes, such as SineWaveGenerator.

Definition at line 19 of file SignalGenerator.h.

Member Typedef Documentation

List

typedef std::vector<Ptr> CPS::Signal::SignalGenerator::List

Definition at line 22 of file SignalGenerator.h.

Ptr

typedef std::shared_ptr<SignalGenerator> CPS::Signal::SignalGenerator::Ptr

Definition at line 21 of file SignalGenerator.h.

Constructor & Destructor Documentation

SignalGenerator() [1/2]

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

Definition at line 13 of file SignalGenerator.cpp.

SignalGenerator() [2/2]

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

inline

Definition at line 30 of file SignalGenerator.h.

Member Function Documentation

getSignal()

Complex Signal::SignalGenerator::getSignal

(

)

returns current signal value without updating it

Definition at line 22 of file SignalGenerator.cpp.

step()

virtual void CPS::Signal::SignalGenerator::step ( Real time )

pure virtual

updates current signal

Implemented in CPS::Signal::CosineFMGenerator, CPS::Signal::DCGenerator, CPS::Signal::FrequencyRampGenerator, and CPS::Signal::SineWaveGenerator.

Member Data Documentation

mFreq

const CPS::Attribute<Real>::Ptr CPS::Signal::SignalGenerator::mFreq

Definition at line 25 of file SignalGenerator.h.

mSigOut

const CPS::Attribute<Complex>::Ptr CPS::Signal::SignalGenerator::mSigOut

Definition at line 24 of file SignalGenerator.h.

---

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

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