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

Field voltage or current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation. More...

#include <OverexcLimX2.hpp>

Inheritance diagram for CIMPP::OverexcLimX2:
Collaboration diagram for CIMPP::OverexcLimX2:

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 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::OverexcitationLimiterDynamics
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 efd1
 Low voltage or current point on the inverse time characteristic (EFD1). Typical value = 1,1. Default: 0.0.
CIMPP::PU efd2
 Mid voltage or current point on the inverse time characteristic (EFD2). Typical value = 1,2. Default: 0.0.
CIMPP::PU efd3
 High voltage or current point on the inverse time characteristic (EFD3). Typical value = 1,5. Default: 0.0.
CIMPP::PU efddes
 Desired field voltage if m = false or desired field current if m = true (EFDDES). Typical value = 1. Default: 0.0.
CIMPP::PU efdrated
 Rated field voltage if m = false or rated field current if m = true (EFDRATED). Typical value = 1,05. Default: 0.0.
CIMPP::PU kmx
 Gain (KMX). Typical value = 0,002. Default: 0.0.
CIMPP::Boolean m
 (m). true = IFD limiting false = EFD limiting. Default: false
CIMPP::Seconds t1
 Time to trip the exciter at the low voltage or current point on the inverse time characteristic (TIME1) (>= 0). Typical value = 120. Default: 0.0.
CIMPP::Seconds t2
 Time to trip the exciter at the mid voltage or current point on the inverse time characteristic (TIME2) (>= 0). Typical value = 40. Default: 0.0.
CIMPP::Seconds t3
 Time to trip the exciter at the high voltage or current point on the inverse time characteristic (TIME3) (>= 0). Typical value = 15. Default: 0.0.
CIMPP::PU vlow
 Low voltage limit (VLOW) (> 0). Default: 0.0.
Public Attributes inherited from CIMPP::OverexcitationLimiterDynamics
CIMPP::ExcitationSystemDynamics * ExcitationSystemDynamics
 Excitation system model with which this overexcitation limiter model is associated. 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 [] = "OverexcLimX2"
Static Public Attributes inherited from CIMPP::OverexcitationLimiterDynamics
static const char debugName [] = "OverexcitationLimiterDynamics"
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

Detailed Description

Field voltage or current overexcitation limiter designed to protect the generator field of an AC machine with automatic excitation control from overheating due to prolonged overexcitation.

Member Function Documentation

◆ addClassGetFnsToMap()

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

◆ addEnumGetFnsToMap()

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

◆ addPrimitiveGetFnsToMap()

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

◆ allAttrDetailsMap()

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

◆ debugString()

const char * OverexcLimX2::debugString ( ) const
overridevirtual

◆ getAttributeNames()

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

◆ getAttributeNamespaceUrl()

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

◆ getClassNamespaceUrl()

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

◆ getPossibleAttributeProfiles()

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

◆ getPossibleProfiles()

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

◆ getPossibleProfilesIncludingAttributes()

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

◆ getRecommendedProfile()

const CGMESProfile & OverexcLimX2::getRecommendedProfile ( ) const
overridevirtual

◆ isAssignableFrom()

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

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