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

A facility for providing variable and controllable shunt reactive power. The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms. The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero. More...

#include <StaticVarCompensator.hpp>

Inheritance diagram for CIMPP::StaticVarCompensator:
Collaboration diagram for CIMPP::StaticVarCompensator:

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::RegulatingCondEq
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::EnergyConnection
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::ConductingEquipment
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::Equipment
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

CIMPP::StaticVarCompensatorDynamics * StaticVarCompensatorDynamics
 Static Var Compensator dynamics model used to describe dynamic behaviour of this Static Var Compensator. Default: nullptr.
CIMPP::Reactance capacitiveRating
 Capacitive reactance at maximum capacitive reactive power. Shall always be positive. Default: 0.0.
CIMPP::Reactance inductiveRating
 Inductive reactance at maximum inductive reactive power. Shall always be negative. Default: 0.0.
CIMPP::ReactivePower q
 Reactive power injection. Load sign convention is used, i.e. positive sign means flow out from a node. Starting value for a steady state solution. Default: 0.0.
CIMPP::SVCControlMode sVCControlMode
 SVC control mode. Default: 0.
CIMPP::VoltagePerReactivePower slope
 The characteristics slope of an SVC defines how the reactive power output changes in proportion to the difference between the regulated bus voltage and the voltage setpoint. The attribute shall be a positive value or zero. Default: 0.0.
CIMPP::Voltage voltageSetPoint
 The reactive power output of the SVC is proportional to the difference between the voltage at the regulated bus and the voltage setpoint. When the regulated bus voltage is equal to the voltage setpoint, the reactive power output is zero. Default: 0.0.
Public Attributes inherited from CIMPP::RegulatingCondEq
CIMPP::RegulatingControl * RegulatingControl
 The regulating control scheme in which this equipment participates. Default: nullptr.
CIMPP::Boolean controlEnabled
 Specifies the regulation status of the equipment. True is regulating, false is not regulating. Default: false.
Public Attributes inherited from CIMPP::ConductingEquipment
CIMPP::BaseVoltage * BaseVoltage
 Base voltage of this conducting equipment. Use only when there is no voltage level container used and only one base voltage applies. For example, not used for transformers. Default: nullptr.
CIMPP::SvStatus * SvStatus
 The status state variable associated with this conducting equipment. Default: nullptr.
std::list< CIMPP::Terminal * > Terminals
 Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: {}.
Public Attributes inherited from CIMPP::Equipment
CIMPP::EquipmentContainer * EquipmentContainer
 Container of this equipment. Default: nullptr.
std::list< CIMPP::OperationalLimitSet * > OperationalLimitSet
 The operational limit sets associated with this equipment. Default: {}.
CIMPP::Boolean aggregate
 The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to true the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine. The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection. Default: false.
CIMPP::Boolean inService
 Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model. Default: false.
CIMPP::Boolean normallyInService
 Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model. Default: false.
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 [] = "StaticVarCompensator"
Static Public Attributes inherited from CIMPP::RegulatingCondEq
static const char debugName [] = "RegulatingCondEq"
Static Public Attributes inherited from CIMPP::EnergyConnection
static const char debugName [] = "EnergyConnection"
Static Public Attributes inherited from CIMPP::ConductingEquipment
static const char debugName [] = "ConductingEquipment"
Static Public Attributes inherited from CIMPP::Equipment
static const char debugName [] = "Equipment"
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

A facility for providing variable and controllable shunt reactive power. The SVC typically consists of a stepdown transformer, filter, thyristor-controlled reactor, and thyristor-switched capacitor arms. The SVC may operate in fixed MVar output mode or in voltage control mode. When in voltage control mode, the output of the SVC will be proportional to the deviation of voltage at the controlled bus from the voltage setpoint. The SVC characteristic slope defines the proportion. If the voltage at the controlled bus is equal to the voltage setpoint, the SVC MVar output is zero.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ debugString()

const char * StaticVarCompensator::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::RegulatingCondEq.

◆ getAttributeNames()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::RegulatingCondEq.

◆ getRecommendedProfile()

const CGMESProfile & StaticVarCompensator::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::RegulatingCondEq.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::RegulatingCondEq.


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