DPsim
Public Types | Public Member Functions | Protected Attributes | List of all members
CPS::SimSignalComp Class Reference

#include <SimSignalComp.h>

Inheritance diagram for CPS::SimSignalComp:
[legend]
Collaboration diagram for CPS::SimSignalComp:
[legend]

Public Types

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

 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)
 

Protected Attributes

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.
 

Additional Inherited Members

- Public Attributes inherited from CPS::IdentifiedObject
const Attribute< String >::Ptr mName
 Human readable name.
 
const Attribute< String >::Ptr mUID
 Unique identifier.
 

Detailed Description

Base class for all signal type components that have only unidirectional connections

Definition at line 17 of file SimSignalComp.h.

Member Data Documentation

◆ mBehaviour

Bool CPS::SimSignalComp::mBehaviour = Behaviour::Simulation
protected

Determine state of the simulation, e.g. to implement special behavior for components during initialization

Definition at line 24 of file SimSignalComp.h.


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