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

Describes behaviour specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment. More...

#include <TapChangerControl.hpp>

Inheritance diagram for CIMPP::TapChangerControl:
Collaboration diagram for CIMPP::TapChangerControl:

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::RegulatingControl
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::PowerSystemResource
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

std::list< CIMPP::TapChanger * > TapChanger
 The tap changers that participates in this regulating tap control scheme. Default: {}.
Public Attributes inherited from CIMPP::RegulatingControl
std::list< CIMPP::RegulatingCondEq * > RegulatingCondEq
 The equipment that participates in this regulating control scheme. Default: {}.
std::list< CIMPP::RegulationSchedule * > RegulationSchedule
 Schedule for this regulating control. Default: {}.
CIMPP::Terminal * Terminal
 The terminal associated with this regulating control. The terminal is associated instead of a node, since the terminal could connect into either a topological node or a connectivity node. Sometimes it is useful to model regulation at a terminal of a bus bar object. Default: nullptr.
CIMPP::Boolean discrete
 The regulation is performed in a discrete mode. This applies to equipment with discrete controls, e.g. tap changers and shunt compensators. Default: false.
CIMPP::Boolean enabled
 The flag tells if regulation is enabled. Default: false.
CIMPP::Float maxAllowedTargetValue
 Maximum allowed target value (RegulatingControl.targetValue). Default: 0.0.
CIMPP::Float minAllowedTargetValue
 Minimum allowed target value (RegulatingControl.targetValue). Default: 0.0.
CIMPP::RegulatingControlModeKind mode
 The regulating control mode presently available. This specification allows for determining the kind of regulation without need for obtaining the units from a schedule. Default: 0.
CIMPP::Float targetDeadband
 This is a deadband used with discrete control to avoid excessive update of controls like tap changers and shunt compensator banks while regulating. The units of those appropriate for the mode. The attribute shall be a positive value or zero. If RegulatingControl.discrete is set to false, the RegulatingControl.targetDeadband is to be ignored. Note that for instance, if the targetValue is 100 kV and the targetDeadband is 2 kV the range is from 99 to 101 kV. Default: 0.0.
CIMPP::Float targetValue
 The target value specified for case input. This value can be used for the target value without the use of schedules. The value has the units appropriate to the mode attribute. Default: 0.0.
CIMPP::UnitMultiplier targetValueUnitMultiplier
 Specify the multiplier for used for the targetValue. Default: 0.
Public Attributes inherited from CIMPP::PowerSystemResource
std::list< CIMPP::Control * > Controls
 The controller outputs used to actually govern a regulating device, e.g. the magnetization of a synchronous machine or capacitor bank breaker actuator. Default: {}.
CIMPP::Location * Location
 Location of this power system resource. Default: nullptr.
std::list< CIMPP::Measurement * > Measurements
 The measurements associated with this power system resource. Default: {}.
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 [] = "TapChangerControl"
Static Public Attributes inherited from CIMPP::RegulatingControl
static const char debugName [] = "RegulatingControl"
Static Public Attributes inherited from CIMPP::PowerSystemResource
static const char debugName [] = "PowerSystemResource"
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

Describes behaviour specific to tap changers, e.g. how the voltage at the end of a line varies with the load level and compensation of the voltage drop by tap adjustment.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingControl.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingControl.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingControl.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::RegulatingControl.

◆ debugString()

const char * TapChangerControl::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::RegulatingControl.

◆ getAttributeNames()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::RegulatingControl.

◆ getRecommendedProfile()

const CGMESProfile & TapChangerControl::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::RegulatingControl.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::RegulatingControl.


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