CPS::TopologicalTerminal Class Reference

Inheritance diagram for CPS::TopologicalTerminal:

Collaboration diagram for CPS::TopologicalTerminal:

Public Types
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
	TopologicalTerminal (String uid, String name, PhaseType phase=PhaseType::Single)
virtual TopologicalNode::Ptr	topologicalNodes ()=0
	Returns reference to TopologicalNode.
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 (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
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.

Additional Inherited Members
Protected Attributes inherited from CPS::IdentifiedObject
AttributeList::Ptr	mAttributes = AttributeList::make()
	Attribute List.

Detailed Description

Definition at line 17 of file TopologicalTerminal.h.

Member Typedef Documentation

List

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

Definition at line 20 of file TopologicalTerminal.h.

Ptr

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

Definition at line 19 of file TopologicalTerminal.h.

Constructor & Destructor Documentation

TopologicalTerminal()

TopologicalTerminal::TopologicalTerminal	(	String	uid,
		String	name,
		PhaseType	phase = PhaseType::Single )

Definition at line 13 of file TopologicalTerminal.cpp.

~TopologicalTerminal()

virtual CPS::TopologicalTerminal::~TopologicalTerminal ( )

inlinevirtual

Definition at line 29 of file TopologicalTerminal.h.

Member Function Documentation

initialSingleVoltage()

Complex TopologicalTerminal::initialSingleVoltage

(

)

Definition at line 37 of file TopologicalTerminal.cpp.

initialVoltage()

MatrixComp TopologicalTerminal::initialVoltage

(

)

Definition at line 58 of file TopologicalTerminal.cpp.

matrixNodeIndex()

UInt TopologicalTerminal::matrixNodeIndex

(

)

Definition at line 41 of file TopologicalTerminal.cpp.

matrixNodeIndices()

std::vector< UInt > TopologicalTerminal::matrixNodeIndices

(

)

Definition at line 45 of file TopologicalTerminal.cpp.

power()

MatrixComp TopologicalTerminal::power

(

)

const

Returns Power as complex matrix, where the size depends on the number of phases.

Definition at line 19 of file TopologicalTerminal.cpp.

setPhaseType()

void TopologicalTerminal::setPhaseType

(

PhaseType

type

)

Definition at line 25 of file TopologicalTerminal.cpp.

setPower() [1/2]

void TopologicalTerminal::setPower

(

Complex

power

)

Definition at line 21 of file TopologicalTerminal.cpp.

setPower() [2/2]

void TopologicalTerminal::setPower

(

MatrixComp

power

)

Definition at line 23 of file TopologicalTerminal.cpp.

singleActivePower()

Real TopologicalTerminal::singleActivePower

(

)

Definition at line 33 of file TopologicalTerminal.cpp.

singlePower()

Complex TopologicalTerminal::singlePower

(

)

Returns single complex number for power.

Definition at line 49 of file TopologicalTerminal.cpp.

singleReactivePower()

Real TopologicalTerminal::singleReactivePower

(

)

Definition at line 35 of file TopologicalTerminal.cpp.

topologicalNodes()

virtual TopologicalNode::Ptr CPS::TopologicalTerminal::topologicalNodes ( )

pure virtual

Returns reference to TopologicalNode.

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

Member Data Documentation

mPhaseType

PhaseType CPS::TopologicalTerminal::mPhaseType

Determines the connection between Component and Node.

Definition at line 22 of file TopologicalTerminal.h.

mPower

MatrixComp CPS::TopologicalTerminal::mPower

Power through the Terminal.

Definition at line 24 of file TopologicalTerminal.h.

---

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

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