#include <Integrator.h>

Inheritance diagram for CPS::Signal::Integrator:

Collaboration diagram for CPS::Signal::Integrator:

Classes
class	PreStep

class	Step

Public Member Functions
	Integrator (String name, Logger::Level logLevel=Logger::Level::off)

void	setParameters (Real timestep)
	Setter for integration step parameter.

void	setInitialValues (Real input_init, Real state_init, Real output_init)
	Setter for initial values.

void	signalPreStep (Real time, Int timeStepCount)
	pre step operations

void	signalStep (Real time, Int timeStepCount)
	step operations

void	signalAddPreStepDependencies (AttributeBase::List &prevStepDependencies, AttributeBase::List &attributeDependencies, AttributeBase::List &modifiedAttributes)
	pre step dependencies

void	signalAddStepDependencies (AttributeBase::List &prevStepDependencies, AttributeBase::List &attributeDependencies, AttributeBase::List &modifiedAttributes)
	add step dependencies

Task::List	getTasks ()

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)

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< Real >::Ptr	mInputRef
	This is never explicitely set to reference anything, so the outside code is responsible for setting up the reference.

const Attribute< Real >::Ptr	mInputPrev
	Previous Input.

const Attribute< Real >::Ptr	mInputCurr
	Current Input.

const Attribute< Real >::Ptr	mStatePrev
	Previous State.

const Attribute< Real >::Ptr	mStateCurr
	Current State.

const Attribute< Real >::Ptr	mOutputPrev
	Previous Output.

const Attribute< Real >::Ptr	mOutputCurr
	Current Output.

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

const Attribute< String >::Ptr	mUID
	Unique identifier.

Protected Attributes
Real	mTimeStep
	Integration time step.

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.

Additional Inherited Members
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< Integrator >
static std::shared_ptr< Integrator >	make (Args &&...args)

Detailed Description

Definition at line 19 of file Integrator.h.

Constructor & Destructor Documentation

◆ Integrator()

Integrator::Integrator	(	String	name,
		Logger::Level	logLevel = Logger::Level::off )

Definition at line 14 of file Integrator.cpp.

Member Function Documentation

◆ getTasks()

Task::List Integrator::getTasks ( )

virtual

Reimplemented from CPS::SimSignalComp.

Definition at line 84 of file Integrator.cpp.

◆ setInitialValues()

void Integrator::setInitialValues	(	Real	input_init,
		Real	state_init,
		Real	output_init )

Setter for initial values.

Definition at line 31 of file Integrator.cpp.

◆ setParameters()

void Integrator::setParameters ( Real timestep )

Setter for integration step parameter.

Definition at line 25 of file Integrator.cpp.

◆ signalAddPreStepDependencies()

void Integrator::signalAddPreStepDependencies	(	AttributeBase::List &	prevStepDependencies,
		AttributeBase::List &	attributeDependencies,
		AttributeBase::List &	modifiedAttributes )

pre step dependencies

Definition at line 43 of file Integrator.cpp.

◆ signalAddStepDependencies()

void Integrator::signalAddStepDependencies	(	AttributeBase::List &	prevStepDependencies,
		AttributeBase::List &	attributeDependencies,
		AttributeBase::List &	modifiedAttributes )

add step dependencies

Definition at line 59 of file Integrator.cpp.

◆ signalPreStep()

void Integrator::signalPreStep	(	Real	time,
		Int	timeStepCount )

pre step operations

Definition at line 53 of file Integrator.cpp.

◆ signalStep()

void Integrator::signalStep	(	Real	time,
		Int	timeStepCount )

step operations

Definition at line 68 of file Integrator.cpp.

Member Data Documentation

◆ mInputCurr

const Attribute<Real>::Ptr CPS::Signal::Integrator::mInputCurr

Current Input.

Definition at line 32 of file Integrator.h.

◆ mInputPrev

const Attribute<Real>::Ptr CPS::Signal::Integrator::mInputPrev

Previous Input.

Definition at line 30 of file Integrator.h.

◆ mInputRef

const Attribute<Real>::Ptr CPS::Signal::Integrator::mInputRef

This is never explicitely set to reference anything, so the outside code is responsible for setting up the reference.

Definition at line 27 of file Integrator.h.

◆ mOutputCurr

const Attribute<Real>::Ptr CPS::Signal::Integrator::mOutputCurr

Current Output.

Definition at line 40 of file Integrator.h.

◆ mOutputPrev

const Attribute<Real>::Ptr CPS::Signal::Integrator::mOutputPrev

Previous Output.

Definition at line 38 of file Integrator.h.

◆ mStateCurr

const Attribute<Real>::Ptr CPS::Signal::Integrator::mStateCurr

Current State.

Definition at line 36 of file Integrator.h.

◆ mStatePrev

const Attribute<Real>::Ptr CPS::Signal::Integrator::mStatePrev

Previous State.

Definition at line 34 of file Integrator.h.

◆ mTimeStep

Real CPS::Signal::Integrator::mTimeStep

protected

Integration time step.

Definition at line 23 of file Integrator.h.

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

/__w/dpsim/dpsim/dpsim-models/include/dpsim-models/Signal/Integrator.h
/__w/dpsim/dpsim/dpsim-models/src/Signal/Integrator.cpp

Classes

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members