Inheritance diagram for CPS::Signal::VCO:

Collaboration diagram for CPS::Signal::VCO:

Classes
class	PreStep

class	Step

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

void	setParameters (Real omegaNom)
	Setter for VCO parameters.

void	setSimulationParameters (Real timestep)
	Setter for simulation parameters.

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 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.

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 Attribute< Real >::Ptr	mInputRef
	Input reference which comes as measurement from outside of the class.

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	mOmegaNom
	Nominal frequency (Input)

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< VCO >
static std::shared_ptr< VCO >	make (Args &&...args)

Detailed Description

Definition at line 13 of file VCO.h.

Constructor & Destructor Documentation

◆ VCO()

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

Definition at line 9 of file VCO.cpp.

Member Function Documentation

◆ getTasks()

Task::List VCO::getTasks ( )

virtual

Reimplemented from CPS::SimSignalComp.

Definition at line 87 of file VCO.cpp.

◆ setInitialValues()

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

Setter for initial values.

Definition at line 34 of file VCO.cpp.

◆ setParameters()

void VCO::setParameters ( Real omegaNom )

Setter for VCO parameters.

Definition at line 19 of file VCO.cpp.

◆ setSimulationParameters()

void VCO::setSimulationParameters ( Real timestep )

Setter for simulation parameters.

Definition at line 29 of file VCO.cpp.

◆ signalAddPreStepDependencies()

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

pre step dependencies

Definition at line 46 of file VCO.cpp.

◆ signalAddStepDependencies()

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

add step dependencies

Definition at line 62 of file VCO.cpp.

◆ signalPreStep()

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

pre step operations

Definition at line 56 of file VCO.cpp.

◆ signalStep()

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

step operations

Definition at line 70 of file VCO.cpp.

Member Data Documentation

◆ mInputCurr

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

Current Input.

Definition at line 27 of file VCO.h.

◆ mInputPrev

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

Previous Input.

Definition at line 25 of file VCO.h.

◆ mInputRef

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

Input reference which comes as measurement from outside of the class.

Definition at line 23 of file VCO.h.

◆ mOmegaNom

Real CPS::Signal::VCO::mOmegaNom

protected

Nominal frequency (Input)

Definition at line 17 of file VCO.h.

◆ mOutputCurr

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

Current Output.

Definition at line 35 of file VCO.h.

◆ mOutputPrev

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

Previous Output.

Definition at line 33 of file VCO.h.

◆ mStateCurr

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

Current State.

Definition at line 31 of file VCO.h.

◆ mStatePrev

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

Previous State.

Definition at line 29 of file VCO.h.

◆ mTimeStep

Real CPS::Signal::VCO::mTimeStep