CPS::SimTerminal< VarType > Class Template Reference

#include <SimTerminal.h>

Inheritance diagram for CPS::SimTerminal< VarType >:

Collaboration diagram for CPS::SimTerminal< VarType >:

Public Types
typedef std::shared_ptr< SimTerminal< VarType > >	Ptr
typedef std::vector< Ptr >	List
Public Types inherited from CPS::TopologicalTerminal
typedef std::shared_ptr< TopologicalTerminal >	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
	SimTerminal (String name)
	SimTerminal (String uid, String name)
SimNode< VarType >::Ptr	node ()
void	setNode (typename SimNode< VarType >::Ptr node)
TopologicalNode::Ptr	topologicalNodes ()
	Returns reference to TopologicalNode.
VarType	singleVoltage ()
MatrixVar< VarType >	voltage ()
Public Member Functions inherited from CPS::TopologicalTerminal
	TopologicalTerminal (String uid, String name, PhaseType phase=PhaseType::Single)
virtual	~TopologicalTerminal ()
MatrixComp	power () const
	Returns Power as complex matrix, where the size depends on the number of phases.
Complex	singlePower ()
	Returns single complex number for power.
void	setPower (Complex power)
void	setPower (MatrixComp power)
void	setPhaseType (PhaseType type)
Real	singleActivePower ()
Real	singleReactivePower ()
Complex	initialSingleVoltage ()
MatrixComp	initialVoltage ()
UInt	matrixNodeIndex ()
std::vector< UInt >	matrixNodeIndices ()
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
MatrixVar< VarType >	mCurrent
std::weak_ptr< SimNode< VarType > >	mNode
Protected Attributes inherited from CPS::IdentifiedObject
AttributeList::Ptr	mAttributes = AttributeList::make()
	Attribute List.

Additional Inherited Members
Static Public Member Functions inherited from SharedFactory< SimTerminal< VarType > >
static std::shared_ptr< SimTerminal< VarType > >	make (Args &&...args)
Public Attributes inherited from CPS::TopologicalTerminal
PhaseType	mPhaseType
	Determines the connection between Component and Node.
MatrixComp	mPower
	Power through the Terminal.
Public Attributes inherited from CPS::IdentifiedObject
const Attribute< String >::Ptr	mName
	Human readable name.
const Attribute< String >::Ptr	mUID
	Unique identifier.

Detailed Description

template<typename VarType>
class CPS::SimTerminal< VarType >

Definition at line 17 of file SimTerminal.h.

Member Typedef Documentation

List

template<typename VarType>

typedef std::vector<Ptr> CPS::SimTerminal< VarType >::List

Definition at line 25 of file SimTerminal.h.

Ptr

template<typename VarType>

typedef std::shared_ptr<SimTerminal<VarType> > CPS::SimTerminal< VarType >::Ptr

Definition at line 24 of file SimTerminal.h.

Constructor & Destructor Documentation

SimTerminal() [1/2]

template<typename VarType>

CPS::SimTerminal< VarType >::SimTerminal ( String name )

inline

Definition at line 27 of file SimTerminal.h.

SimTerminal() [2/2]

template<typename VarType>

CPS::SimTerminal< VarType >::SimTerminal ( String uid, String name )

inline

Definition at line 29 of file SimTerminal.h.

Member Function Documentation

node()

template<typename VarType>

SimNode< VarType >::Ptr CPS::SimTerminal< VarType >::node ( )

inline

Definition at line 31 of file SimTerminal.h.

setNode()

template<typename VarType>

void CPS::SimTerminal< VarType >::setNode ( typename SimNode< VarType >::Ptr node )

inline

Definition at line 33 of file SimTerminal.h.

singleVoltage()

template<typename VarType>

VarType CPS::SimTerminal< VarType >::singleVoltage ( )

inline

Definition at line 40 of file SimTerminal.h.

topologicalNodes()

template<typename VarType>

TopologicalNode::Ptr CPS::SimTerminal< VarType >::topologicalNodes ( )

inlinevirtual

Returns reference to TopologicalNode.

Implements CPS::TopologicalTerminal.

Definition at line 38 of file SimTerminal.h.

voltage()

template<typename VarType>

MatrixVar< VarType > CPS::SimTerminal< VarType >::voltage ( )

inline

Definition at line 47 of file SimTerminal.h.

Member Data Documentation

mCurrent

template<typename VarType>

MatrixVar<VarType> CPS::SimTerminal< VarType >::mCurrent

protected

Definition at line 20 of file SimTerminal.h.

mNode

template<typename VarType>

std::weak_ptr<SimNode<VarType> > CPS::SimTerminal< VarType >::mNode

protected

Definition at line 21 of file SimTerminal.h.

---

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

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