DPsim
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
CPS::Base::Ph1::Switch Class Reference

Dynamic Phasor Three-Phase Switch. More...

#include <Base_Ph1_Switch.h>

Inheritance diagram for CPS::Base::Ph1::Switch:
[legend]
Collaboration diagram for CPS::Base::Ph1::Switch:
[legend]

Public Member Functions

 Switch (CPS::AttributeList::Ptr attributeList)
 
virtual ~Switch ()=default
 
void setParameters (Real openResistance, Real closedResistance, Bool closed=false)
 
virtual void closeSwitch ()
 
virtual void openSwitch ()
 
void close ()
 Close switch.
 
void open ()
 Open switch.
 
Bool isClosed ()
 Check if switch is closed.
 

Public Attributes

const Attribute< Real >::Ptr mOpenResistance
 Resistance if switch is open [ohm].
 
const Attribute< Real >::Ptr mClosedResistance
 Resistance if switch is closed [ohm].
 
const Attribute< Bool >::Ptr mIsClosed
 Defines if Switch is open or closed.
 

Protected Attributes

Bool mIsClosedPrev = false
 

Detailed Description

Dynamic Phasor Three-Phase Switch.

Definition at line 18 of file Base_Ph1_Switch.h.

Constructor & Destructor Documentation

◆ Switch()

CPS::Base::Ph1::Switch::Switch ( CPS::AttributeList::Ptr attributeList)
inlineexplicit

Definition at line 30 of file Base_Ph1_Switch.h.

◆ ~Switch()

virtual CPS::Base::Ph1::Switch::~Switch ( )
virtualdefault

Member Function Documentation

◆ close()

void CPS::Base::Ph1::Switch::close ( )
inline

Close switch.

Definition at line 58 of file Base_Ph1_Switch.h.

◆ closeSwitch()

virtual void CPS::Base::Ph1::Switch::closeSwitch ( )
inlinevirtual

Close command.

Virtual so domain-specific breaker models can distinguish commanded state from the physical pole state.

Reimplemented in CPS::DP::Ph1::Switch.

Definition at line 49 of file Base_Ph1_Switch.h.

◆ isClosed()

Bool CPS::Base::Ph1::Switch::isClosed ( )
inline

Check if switch is closed.

Definition at line 62 of file Base_Ph1_Switch.h.

◆ open()

void CPS::Base::Ph1::Switch::open ( )
inline

Open switch.

Definition at line 60 of file Base_Ph1_Switch.h.

◆ openSwitch()

virtual void CPS::Base::Ph1::Switch::openSwitch ( )
inlinevirtual

Open command.

Virtual so current-zero breakers can remain physically conducting after the command until the current reaches zero.

Reimplemented in CPS::DP::Ph1::Switch.

Definition at line 55 of file Base_Ph1_Switch.h.

◆ setParameters()

void CPS::Base::Ph1::Switch::setParameters ( Real openResistance,
Real closedResistance,
Bool closed = false )
inline

Definition at line 38 of file Base_Ph1_Switch.h.

Member Data Documentation

◆ mClosedResistance

const Attribute<Real>::Ptr CPS::Base::Ph1::Switch::mClosedResistance

Resistance if switch is closed [ohm].

Definition at line 26 of file Base_Ph1_Switch.h.

◆ mIsClosed

const Attribute<Bool>::Ptr CPS::Base::Ph1::Switch::mIsClosed

Defines if Switch is open or closed.

Definition at line 28 of file Base_Ph1_Switch.h.

◆ mIsClosedPrev

Bool CPS::Base::Ph1::Switch::mIsClosedPrev = false
protected

Definition at line 20 of file Base_Ph1_Switch.h.

◆ mOpenResistance

const Attribute<Real>::Ptr CPS::Base::Ph1::Switch::mOpenResistance

Resistance if switch is open [ohm].

Definition at line 24 of file Base_Ph1_Switch.h.

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