CIMPP::ExcST6B Class Reference

Modified IEEE ST6B static excitation system with PID controller and optional inner feedback loop. More...

#include <ExcST6B.hpp>

Inheritance diagram for CIMPP::ExcST6B:

Collaboration diagram for CIMPP::ExcST6B:

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::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	ilr
	Exciter output current limit reference (Ilr) (> 0). Typical value = 4,164. Default: 0.0.
CIMPP::Boolean	k1
	Selector (K1). true = feedback is from Ifd false = feedback is not from Ifd. Typical value = true. Default: false.
CIMPP::PU	kcl
	Exciter output current limit adjustment (Kcl) (> 0). Typical value = 1,0577. Default: 0.0.
CIMPP::PU	kff
	Pre-control gain constant of the inner loop field regulator (Kff). Typical value = 1. Default: 0.0.
CIMPP::PU	kg
	Feedback gain constant of the inner loop field regulator (Kg) (>= 0). Typical value = 1. Default: 0.0.
CIMPP::PU	kia
	Voltage regulator integral gain (Kia) (> 0). Typical value = 45,094. Default: 0.0.
CIMPP::PU	klr
	Exciter output current limit adjustment (Kcl) (> 0). Typical value = 17,33. Default: 0.0.
CIMPP::PU	km
	Forward gain constant of the inner loop field regulator (Km). Typical value = 1. Default: 0.0.
CIMPP::PU	kpa
	Voltage regulator proportional gain (Kpa) (> 0). Typical value = 18,038. Default: 0.0.
CIMPP::PU	kvd
	Voltage regulator derivative gain (Kvd). Typical value = 0. Default: 0.0.
CIMPP::ExcST6BOELselectorKind	oelin
	OEL input selector (OELin). Typical value = noOELinput (corresponds to OELin = 0 on diagram). Default: 0.
CIMPP::Seconds	tg
	Feedback time constant of inner loop field voltage regulator (Tg) (>= 0). Typical value = 0,02. Default: 0.0.
CIMPP::Seconds	ts
	Rectifier firing time constant (Ts) (>= 0). Typical value = 0. Default: 0.0.
CIMPP::Seconds	tvd
	Voltage regulator derivative gain (Tvd) (>= 0). Typical value = 0. Default: 0.0.
CIMPP::PU	vamax
	Maximum voltage regulator output (Vamax) (> 0). Typical value = 4,81. Default: 0.0.
CIMPP::PU	vamin
	Minimum voltage regulator output (Vamin) (< 0). Typical value = -3,85. Default: 0.0.
CIMPP::Boolean	vilim
	Selector (Vilim). true = Vimin-Vimax limiter is active false = Vimin-Vimax limiter is not active. Typical value = true. Default: false.
CIMPP::PU	vimax
	Maximum voltage regulator input limit (Vimax) (> ExcST6B.vimin). Typical value = 10. Default: 0.0.
CIMPP::PU	vimin
	Minimum voltage regulator input limit (Vimin) (< ExcST6B.vimax). Typical value = -10. Default: 0.0.
CIMPP::Boolean	vmult
	Selector (vmult). true = multiply regulator output by terminal voltage false = do not multiply regulator output by terminal voltage. Typical value = true. Default: false.
CIMPP::PU	vrmax
	Maximum voltage regulator output (Vrmax) (> 0). Typical value = 4,81. Default: 0.0.
CIMPP::PU	vrmin
	Minimum voltage regulator output (Vrmin) (< 0). Typical value = -3,85. Default: 0.0.
CIMPP::PU	xc
	Excitation source reactance (Xc). Typical value = 0,05. 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 [] = "ExcST6B"
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::IdentifiedObject
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

Modified IEEE ST6B static excitation system with PID controller and optional inner feedback loop.

Member Function Documentation

addClassGetFnsToMap()

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

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

addEnumGetFnsToMap()

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

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

addPrimitiveGetFnsToMap()

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

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

allAttrDetailsMap()

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

overrideprotectedvirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

debugString()

const char * ExcST6B::debugString ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getAttributeNames()

const std::list< std::string > & ExcST6B::getAttributeNames ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getAttributeNamespaceUrl()

const std::string & ExcST6B::getAttributeNamespaceUrl ( const std::string & attrName ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getClassNamespaceUrl()

const std::string & ExcST6B::getClassNamespaceUrl ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getPossibleAttributeProfiles()

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

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getPossibleProfiles()

const std::list< CGMESProfile > & ExcST6B::getPossibleProfiles ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & ExcST6B::getPossibleProfilesIncludingAttributes ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

getRecommendedProfile()

const CGMESProfile & ExcST6B::getRecommendedProfile ( ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

isAssignableFrom()

bool ExcST6B::isAssignableFrom ( BaseClass * otherObject ) const

overridevirtual

Reimplemented from CIMPP::ExcitationSystemDynamics.

---

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

• CGMES_3.0.0/ExcST6B.hpp
• CGMES_3.0.0/ExcST6B.cpp