CPS::TopologicalNode Class Reference

#include <TopologicalNode.h>

Inheritance diagram for CPS::TopologicalNode:

Collaboration diagram for CPS::TopologicalNode:

Public Types
typedef std::shared_ptr< TopologicalNode >	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
	TopologicalNode ()
	TopologicalNode (String uid, String name, PhaseType phaseType, const std::vector< Complex > &initialVoltage)
	This very general constructor is used by other constructors.
virtual	~TopologicalNode ()
Bool	isGround () const
MatrixComp	initialVoltage () const
void	setInitialVoltage (MatrixComp voltage) const
void	setInitialVoltage (Complex voltage) const
void	setInitialVoltage (Complex voltage, Int phaseIndex) const
Complex	initialSingleVoltage (PhaseType phaseType=PhaseType::Single)
PhaseType	phaseType () const
virtual UInt	matrixNodeIndex (PhaseType phaseType=PhaseType::Single)=0
virtual std::vector< UInt >	matrixNodeIndices ()=0
virtual void	setMatrixNodeIndex (UInt phase, UInt matrixNodeIndex)=0
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< MatrixComp >::Ptr	mInitialVoltage
Public Attributes inherited from CPS::IdentifiedObject
const Attribute< String >::Ptr	mName
	Human readable name.
const Attribute< String >::Ptr	mUID
	Unique identifier.

Protected Attributes
PhaseType	mPhaseType = PhaseType::Single
Bool	mIsGround = false
Protected Attributes inherited from CPS::IdentifiedObject
AttributeList::Ptr	mAttributes = AttributeList::make()
	Attribute List.

Detailed Description

Definition at line 17 of file TopologicalNode.h.

Member Typedef Documentation

List

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

Definition at line 24 of file TopologicalNode.h.

Ptr

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

Definition at line 23 of file TopologicalNode.h.

Constructor & Destructor Documentation

TopologicalNode() [1/2]

CPS::TopologicalNode::TopologicalNode ( )

inline

Definition at line 28 of file TopologicalNode.h.

TopologicalNode() [2/2]

TopologicalNode::TopologicalNode	(	String	uid,
		String	name,
		PhaseType	phaseType,
		const std::vector< Complex > &	initialVoltage )

This very general constructor is used by other constructors.

Definition at line 37 of file TopologicalNode.cpp.

~TopologicalNode()

virtual CPS::TopologicalNode::~TopologicalNode ( )

inlinevirtual

Definition at line 33 of file TopologicalNode.h.

Member Function Documentation

initialSingleVoltage()

Complex TopologicalNode::initialSingleVoltage

(

PhaseType

phaseType = PhaseType::Single

)

Definition at line 55 of file TopologicalNode.cpp.

initialVoltage()

MatrixComp TopologicalNode::initialVoltage

(

)

const

Definition at line 15 of file TopologicalNode.cpp.

isGround()

Bool TopologicalNode::isGround

(

)

const

Definition at line 13 of file TopologicalNode.cpp.

matrixNodeIndex()

virtual UInt CPS::TopologicalNode::matrixNodeIndex ( PhaseType phaseType = PhaseType::Single )

pure virtual

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

matrixNodeIndices()

virtual std::vector< UInt > CPS::TopologicalNode::matrixNodeIndices ( )

pure virtual

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

phaseType()

PhaseType TopologicalNode::phaseType

(

)

const

Definition at line 35 of file TopologicalNode.cpp.

setInitialVoltage() [1/3]

void TopologicalNode::setInitialVoltage

(

Complex

voltage

)

const

Definition at line 21 of file TopologicalNode.cpp.

setInitialVoltage() [2/3]

void TopologicalNode::setInitialVoltage	(	Complex	voltage,
		Int	phaseIndex ) const

Definition at line 31 of file TopologicalNode.cpp.

setInitialVoltage() [3/3]

void TopologicalNode::setInitialVoltage

(

MatrixComp

voltage

)

const

Definition at line 17 of file TopologicalNode.cpp.

setMatrixNodeIndex()

virtual void CPS::TopologicalNode::setMatrixNodeIndex ( UInt phase, UInt matrixNodeIndex )

pure virtual

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

Member Data Documentation

mInitialVoltage

const Attribute<MatrixComp>::Ptr CPS::TopologicalNode::mInitialVoltage

Definition at line 26 of file TopologicalNode.h.

mIsGround

Bool CPS::TopologicalNode::mIsGround = false

protected

Definition at line 20 of file TopologicalNode.h.

mPhaseType

PhaseType CPS::TopologicalNode::mPhaseType = PhaseType::Single

protected

Definition at line 19 of file TopologicalNode.h.

---

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

• /__w/dpsim/dpsim/dpsim-models/include/dpsim-models/TopologicalNode.h
• /__w/dpsim/dpsim/dpsim-models/src/TopologicalNode.cpp