CGMES_3_0_0
Loading...
Searching...
No Matches
CIMPP::ExcIEEEST5B Class Reference

IEEE 421.5-2005 type ST5B model. The type ST5B excitation system is a variation of the type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. The block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref. Reference: IEEE 421.5-2005, 7.5. More...

#include <ExcIEEEST5B.hpp>

Inheritance diagram for CIMPP::ExcIEEEST5B:
Inheritance graph
[legend]
Collaboration diagram for CIMPP::ExcIEEEST5B:
Collaboration graph
[legend]

Public Member Functions

const char * debugString () const override
const std::list< std::string > & getAttributeNames () const override
const std::string & getClassNamespaceUrl () const override
const std::string & getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfiles () const override
const CGMESProfile & getRecommendedProfile () const override
const std::list< CGMESProfile > & getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfilesIncludingAttributes () const override
void addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::ExcitationSystemDynamics
const char * debugString () const override
const std::list< std::string > & getAttributeNames () const override
const std::string & getClassNamespaceUrl () const override
const std::string & getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfiles () const override
const CGMESProfile & getRecommendedProfile () const override
const std::list< CGMESProfile > & getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfilesIncludingAttributes () const override
void addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from CIMPP::IdentifiedObject
const char * debugString () const override
const std::list< std::string > & getAttributeNames () const override
const std::string & getClassNamespaceUrl () const override
const std::string & getAttributeNamespaceUrl (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfiles () const override
const CGMESProfile & getRecommendedProfile () const override
const std::list< CGMESProfile > & getPossibleAttributeProfiles (const std::string &attrName) const override
const std::list< CGMESProfile > & getPossibleProfilesIncludingAttributes () const override
void addPrimitiveGetFnsToMap (std::map< std::string, get_function > &get_map) const override
void addClassGetFnsToMap (std::map< std::string, class_get_function > &get_map) const override
void addEnumGetFnsToMap (std::map< std::string, get_function > &get_map) const override
bool isAssignableFrom (BaseClass *otherObject) const override
Public Member Functions inherited from BaseClass
void setRdfid (const std::string &id)
std::string getRdfid () const

Static Public Member Functions

static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::ExcitationSystemDynamics
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::DynamicsFunctionBlock
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from CIMPP::IdentifiedObject
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const BaseClassDefiner declare ()
Static Public Member Functions inherited from BaseClass
static void addConstructToMap (std::unordered_map< std::string, BaseClass *(*)()> &factory_map)
static void addPrimitiveAssignFnsToMap (std::unordered_map< std::string, assign_function > &assign_map)
static void addClassAssignFnsToMap (std::unordered_map< std::string, class_assign_function > &assign_map)
static const CIMPP::BaseClassDefiner declare ()

Public Attributes

CIMPP::PU kc
 Rectifier regulation factor (KC) (>= 0). Typical value = 0,004. Default: 0.0.
CIMPP::PU kr
 Regulator gain (KR) (> 0). Typical value = 200. Default: 0.0.
CIMPP::Seconds t1
 Firing circuit time constant (T1) (>= 0). Typical value = 0,004. Default: 0.0.
CIMPP::Seconds tb1
 Regulator lag time constant (TB1) (>= 0). Typical value = 6. Default: 0.0.
CIMPP::Seconds tb2
 Regulator lag time constant (TB2) (>= 0). Typical value = 0,01. Default: 0.0.
CIMPP::Seconds tc1
 Regulator lead time constant (TC1) (>= 0). Typical value = 0,8. Default: 0.0.
CIMPP::Seconds tc2
 Regulator lead time constant (TC2) (>= 0). Typical value = 0,08. Default: 0.0.
CIMPP::Seconds tob1
 OEL lag time constant (TOB1) (>= 0). Typical value = 2. Default: 0.0.
CIMPP::Seconds tob2
 OEL lag time constant (TOB2) (>= 0). Typical value = 0,08. Default: 0.0.
CIMPP::Seconds toc1
 OEL lead time constant (TOC1) (>= 0). Typical value = 0,1. Default: 0.0.
CIMPP::Seconds toc2
 OEL lead time constant (TOC2) (>= 0). Typical value = 0,08. Default: 0.0.
CIMPP::Seconds tub1
 UEL lag time constant (TUB1) (>= 0). Typical value = 10. Default: 0.0.
CIMPP::Seconds tub2
 UEL lag time constant (TUB2) (>= 0). Typical value = 0,05. Default: 0.0.
CIMPP::Seconds tuc1
 UEL lead time constant (TUC1) (>= 0). Typical value = 2. Default: 0.0.
CIMPP::Seconds tuc2
 UEL lead time constant (TUC2) (>= 0). Typical value = 0,1. Default: 0.0.
CIMPP::PU vrmax
 Maximum voltage regulator output (VRMAX) (> 0). Typical value = 5. Default: 0.0.
CIMPP::PU vrmin
 Minimum voltage regulator output (VRMIN) (< 0). Typical value = -4. Default: 0.0.
Public Attributes inherited from CIMPP::ExcitationSystemDynamics
CIMPP::DiscontinuousExcitationControlDynamics * DiscontinuousExcitationControlDynamics
 Discontinuous excitation control model associated with this excitation system model. Default: nullptr.
CIMPP::OverexcitationLimiterDynamics * OverexcitationLimiterDynamics
 Overexcitation limiter model associated with this excitation system model. Default: nullptr.
CIMPP::PFVArControllerType1Dynamics * PFVArControllerType1Dynamics
 Power factor or VAr controller type 1 model associated with this excitation system model. Default: nullptr.
CIMPP::PFVArControllerType2Dynamics * PFVArControllerType2Dynamics
 Power factor or VAr controller type 2 model associated with this excitation system model. Default: nullptr.
CIMPP::PowerSystemStabilizerDynamics * PowerSystemStabilizerDynamics
 Power system stabilizer model associated with this excitation system model. Default: nullptr.
CIMPP::SynchronousMachineDynamics * SynchronousMachineDynamics
 Synchronous machine model with which this excitation system model is associated. Default: nullptr.
CIMPP::UnderexcitationLimiterDynamics * UnderexcitationLimiterDynamics
 Undrexcitation limiter model associated with this excitation system model. Default: nullptr.
CIMPP::VoltageCompensatorDynamics * VoltageCompensatorDynamics
 Voltage compensator model associated with this excitation system model. Default: nullptr.
Public Attributes inherited from CIMPP::DynamicsFunctionBlock
CIMPP::Boolean enabled
 Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: false.
Public Attributes inherited from CIMPP::IdentifiedObject
std::list< CIMPP::DiagramObject * > DiagramObjects
 The diagram objects that are associated with the domain object. Default: {}.
CIMPP::String description
 The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy. Default: "".
CIMPP::String energyIdentCodeEic
 The attribute is used for an exchange of the EIC code (Energy identification Code). The length of the string is 16 characters as defined by the EIC code. For details on EIC scheme please refer to ENTSO-E web site. Default: "".
CIMPP::String mRID
 Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended. For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements. Default: "".
CIMPP::String name
 The name is any free human readable and possibly non unique text naming the object. Default: "".
CIMPP::String shortName
 The attribute is used for an exchange of a human readable short name with length of the string 12 characters maximum. Default: "".

Static Public Attributes

static const char debugName [] = "ExcIEEEST5B"
Static Public Attributes inherited from CIMPP::ExcitationSystemDynamics
static const char debugName [] = "ExcitationSystemDynamics"
Static Public Attributes inherited from CIMPP::DynamicsFunctionBlock
static const char debugName [] = "DynamicsFunctionBlock"
Static Public Attributes inherited from CIMPP::IdentifiedObject
static const char debugName [] = "IdentifiedObject"
Static Public Attributes inherited from BaseClass
static const char debugName [] = "BaseClass"

Protected Member Functions

std::map< std::string, AttrDetails > allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::ExcitationSystemDynamics
std::map< std::string, AttrDetails > allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::IdentifiedObject
std::map< std::string, AttrDetails > allAttrDetailsMap () const override

Detailed Description

IEEE 421.5-2005 type ST5B model. The type ST5B excitation system is a variation of the type ST1A model, with alternative overexcitation and underexcitation inputs and additional limits. The block diagram in the IEEE 421.5 standard has input signal Vc and does not indicate the summation point with Vref. The implementation of the ExcIEEEST5B shall consider summation point with Vref. Reference: IEEE 421.5-2005, 7.5.

Member Function Documentation

◆ addClassGetFnsToMap()

void ExcIEEEST5B::addClassGetFnsToMap ( std::map< std::string, class_get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ addEnumGetFnsToMap()

void ExcIEEEST5B::addEnumGetFnsToMap ( std::map< std::string, get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ addPrimitiveGetFnsToMap()

void ExcIEEEST5B::addPrimitiveGetFnsToMap ( std::map< std::string, get_function > & get_map) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ allAttrDetailsMap()

std::map< std::string, AttrDetails > ExcIEEEST5B::allAttrDetailsMap ( ) const
overrideprotectedvirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ debugString()

const char * ExcIEEEST5B::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getAttributeNames()

const std::list< std::string > & ExcIEEEST5B::getAttributeNames ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getAttributeNamespaceUrl()

const std::string & ExcIEEEST5B::getAttributeNamespaceUrl ( const std::string & attrName) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getClassNamespaceUrl()

const std::string & ExcIEEEST5B::getClassNamespaceUrl ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleAttributeProfiles()

const std::list< CGMESProfile > & ExcIEEEST5B::getPossibleAttributeProfiles ( const std::string & attrName) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleProfiles()

const std::list< CGMESProfile > & ExcIEEEST5B::getPossibleProfiles ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & ExcIEEEST5B::getPossibleProfilesIncludingAttributes ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ getRecommendedProfile()

const CGMESProfile & ExcIEEEST5B::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

◆ isAssignableFrom()

bool ExcIEEEST5B::isAssignableFrom ( BaseClass * otherObject) const
overridevirtual

Reimplemented from CIMPP::DynamicsFunctionBlock.

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