DPsim
Public Types | Public Member Functions | Protected Attributes | List of all members
CPS::TopologicalPowerComp Class Referenceabstract

#include <TopologicalPowerComp.h>

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

Public Types

enum  Behaviour { Initialization , MNASimulation , PFSimulation }
 
typedef std::shared_ptr< TopologicalPowerCompPtr
 
typedef std::vector< Ptr > List
 
- Public Types inherited from CPS::IdentifiedObject
typedef std::shared_ptr< IdentifiedObjectPtr
 
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 (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

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


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