CPS::TopologicalPowerComp Class Reference

#include <TopologicalPowerComp.h>

Inheritance diagram for CPS::TopologicalPowerComp:

Collaboration diagram for CPS::TopologicalPowerComp:

Public Types
enum	Behaviour { Initialization , MNASimulation , PFSimulation }
typedef std::shared_ptr< TopologicalPowerComp >	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
	TopologicalPowerComp (String uid, String name, Logger::Level logLevel=Logger::Level::off)
	Basic constructor that takes UID, name and log level.
	TopologicalPowerComp (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	~TopologicalPowerComp ()
	Destructor - does not do anything.
virtual TopologicalNode::List	topologicalNodes ()=0
	Returns nodes connected to this component.
virtual TopologicalTerminal::List	topologicalTerminals ()=0
	Returns terminal that are part of the component.
void	setBehaviour (Behaviour behaviour)
	Set behavior of component, e.g. initialization.
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 ()

Protected Attributes
UInt	mNumTerminals = 0
	Determines the number of Terminals which can be connected to network Nodes.
UInt	mNumVirtualNodes = 0
	Determines the number of virtual or internal Nodes.
Logger::Log	mSLog
	Component logger.
Logger::Level	mLogLevel
	Component logger control for internal variables.
Behaviour	mBehaviour = Behaviour::MNASimulation
bool	mParametersSet = false
	Flag indicating that parameters are set via setParameters() function.
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 electrical components that are connected to nodes via terminals

Definition at line 24 of file TopologicalPowerComp.h.

Member Typedef Documentation

List

typedef std::vector<Ptr> CPS::TopologicalPowerComp::List

Definition at line 45 of file TopologicalPowerComp.h.

Ptr

typedef std::shared_ptr<TopologicalPowerComp> CPS::TopologicalPowerComp::Ptr

Definition at line 44 of file TopologicalPowerComp.h.

Member Enumeration Documentation

Behaviour

enum CPS::TopologicalPowerComp::Behaviour

Enumerator
Initialization
MNASimulation
PFSimulation

Definition at line 26 of file TopologicalPowerComp.h.

Constructor & Destructor Documentation

TopologicalPowerComp() [1/2]

CPS::TopologicalPowerComp::TopologicalPowerComp ( String uid, String name, Logger::Level logLevel = Logger::Level::off )

inline

Basic constructor that takes UID, name and log level.

Definition at line 48 of file TopologicalPowerComp.h.

TopologicalPowerComp() [2/2]

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

inline

Basic constructor that takes name and log level and sets the UID to name as well.

Definition at line 58 of file TopologicalPowerComp.h.

~TopologicalPowerComp()

virtual CPS::TopologicalPowerComp::~TopologicalPowerComp ( )

inlinevirtual

Destructor - does not do anything.

Definition at line 61 of file TopologicalPowerComp.h.

Member Function Documentation

setBehaviour()

void CPS::TopologicalPowerComp::setBehaviour ( Behaviour behaviour )

inline

Set behavior of component, e.g. initialization.

Definition at line 68 of file TopologicalPowerComp.h.

topologicalNodes()

virtual TopologicalNode::List CPS::TopologicalPowerComp::topologicalNodes ( )

pure virtual

Returns nodes connected to this component.

Implemented in CPS::SimPowerComp< VarType >, CPS::SimPowerComp< Complex >, and CPS::SimPowerComp< Real >.

topologicalTerminals()

virtual TopologicalTerminal::List CPS::TopologicalPowerComp::topologicalTerminals ( )

pure virtual

Returns terminal that are part of the component.

Implemented in CPS::SimPowerComp< VarType >, CPS::SimPowerComp< Complex >, and CPS::SimPowerComp< Real >.

Member Data Documentation

mBehaviour

Behaviour CPS::TopologicalPowerComp::mBehaviour = Behaviour::MNASimulation

protected

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

Definition at line 39 of file TopologicalPowerComp.h.

mLogLevel

Logger::Level CPS::TopologicalPowerComp::mLogLevel

protected

Component logger control for internal variables.

Definition at line 36 of file TopologicalPowerComp.h.

mNumTerminals

UInt CPS::TopologicalPowerComp::mNumTerminals = 0

protected

Determines the number of Terminals which can be connected to network Nodes.

Definition at line 30 of file TopologicalPowerComp.h.

mNumVirtualNodes

UInt CPS::TopologicalPowerComp::mNumVirtualNodes = 0

protected

Determines the number of virtual or internal Nodes.

Definition at line 32 of file TopologicalPowerComp.h.

mParametersSet

bool CPS::TopologicalPowerComp::mParametersSet = false

protected

Flag indicating that parameters are set via setParameters() function.

Definition at line 41 of file TopologicalPowerComp.h.

mSLog

Logger::Log CPS::TopologicalPowerComp::mSLog

protected

Component logger.

Definition at line 34 of file TopologicalPowerComp.h.

---

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

• /__w/dpsim/dpsim/dpsim-models/include/dpsim-models/TopologicalPowerComp.h