DPsim
Public Types | Public Member Functions | Public Attributes | List of all members
CPS::Signal::SignalGenerator Class Referenceabstract

Model to generate generic signals. More...

#include <SignalGenerator.h>

Inheritance diagram for CPS::Signal::SignalGenerator:
[legend]
Collaboration diagram for CPS::Signal::SignalGenerator:
[legend]

Public Types

typedef std::shared_ptr< SignalGeneratorPtr
 
typedef std::vector< Ptr > List
 
- Public Types inherited from CPS::SimSignalComp
enum  Behaviour { Initialization , Simulation }
 
typedef std::shared_ptr< SimSignalCompPtr
 
typedef std::vector< Ptr > List
 
- Public Types inherited from CPS::TopologicalSignalComp
typedef std::shared_ptr< TopologicalSignalCompPtr
 
typedef std::vector< Ptr > List
 
- Public Types inherited from CPS::IdentifiedObject
typedef std::shared_ptr< IdentifiedObjectPtr
 
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)
 

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.


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