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

An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump. More...

#include <SynchronousMachine.hpp>

Inheritance diagram for CIMPP::SynchronousMachine:
Collaboration diagram for CIMPP::SynchronousMachine:

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::RotatingMachine
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::ReactiveCapabilityCurve * InitialReactiveCapabilityCurve
 The default reactive capability curve for use by a synchronous machine. Default: nullptr.
CIMPP::SynchronousMachineDynamics * SynchronousMachineDynamics
 Synchronous machine dynamics model used to describe dynamic behaviour of this synchronous machine. Default: nullptr.
CIMPP::Boolean earthing
 Indicates whether or not the generator is earthed. Used for short circuit data exchange according to IEC 60909. Default: false.
CIMPP::Resistance earthingStarPointR
 Generator star point earthing resistance (Re). Used for short circuit data exchange according to IEC 60909. Default: 0.0.
CIMPP::Reactance earthingStarPointX
 Generator star point earthing reactance (Xe). Used for short circuit data exchange according to IEC 60909. Default: 0.0.
CIMPP::CurrentFlow ikk
 Steady-state short-circuit current (in A for the profile) of generator with compound excitation during 3-phase short circuit. - Ikk=0: Generator with no compound excitation. - Ikk<>0: Generator with compound excitation. Ikk is used to calculate the minimum steady-state short-circuit current for generators with compound excitation. (4.6.1.2 in IEC 60909-0:2001). Used only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001). Default: 0.0.
CIMPP::ReactivePower maxQ
 Maximum reactive power limit. This is the maximum (nameplate) limit for the unit. Default: 0.0.
CIMPP::ReactivePower minQ
 Minimum reactive power limit for the unit. Default: 0.0.
CIMPP::Float mu
 Factor to calculate the breaking current (Section 4.5.2.1 in IEC 60909-0). Used only for single fed short circuit on a generator (Section 4.3.4.2. in IEC 60909-0). Default: 0.0.
CIMPP::SynchronousMachineOperatingMode operatingMode
 Current mode of operation. Default: 0.
CIMPP::PerCent qPercent
 Part of the coordinated reactive control that comes from this machine. The attribute is used as a participation factor not necessarily summing up to 100% for the participating devices in the control. Default: 0.0.
CIMPP::Resistance r
 Equivalent resistance (RG) of generator. RG is considered for the calculation of all currents, except for the calculation of the peak current ip. Used for short circuit data exchange according to IEC 60909. Default: 0.0.
CIMPP::Resistance r0
 Zero sequence resistance of the synchronous machine. Default: 0.0.
CIMPP::Resistance r2
 Negative sequence resistance. Default: 0.0.
CIMPP::Integer referencePriority
 Priority of unit for use as powerflow voltage phase angle reference bus selection. 0 = don t care (default) 1 = highest priority. 2 is less than 1 and so on. Default: 0.
CIMPP::PU satDirectSyncX
 Direct-axis subtransient reactance saturated, also known as Xd`sat. Default: 0.0 */ CIMPP::PU satDirectSubtransX;.
CIMPP::PU satDirectTransX
 Saturated Direct-axis transient reactance. The attribute is primarily used for short circuit calculations according to ANSI. Default: 0.0.
CIMPP::ShortCircuitRotorKind shortCircuitRotorType
 Type of rotor, used by short circuit applications, only for single fed short circuit according to IEC 60909. Default: 0.
CIMPP::SynchronousMachineKind type
 Modes that this synchronous machine can operate in. Default: 0.
CIMPP::PerCent voltageRegulationRange
 Range of generator voltage regulation (PG in IEC 60909-0) used for calculation of the impedance correction factor KG defined in IEC 60909-0. This attribute is used to describe the operating voltage of the generating unit. Default: 0.0.
CIMPP::Reactance x0
 Zero sequence reactance of the synchronous machine. Default: 0.0.
CIMPP::Reactance x2
 Negative sequence reactance. Default: 0.0.
Public Attributes inherited from CIMPP::RotatingMachine
CIMPP::GeneratingUnit * GeneratingUnit
 A synchronous machine may operate as a generator and as such becomes a member of a generating unit. Default: nullptr.
CIMPP::HydroPump * HydroPump
 The synchronous machine drives the turbine which moves the water from a low elevation to a higher elevation. The direction of machine rotation for pumping may or may not be the same as for generating. Default: nullptr.
CIMPP::ActivePower p
 Active 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::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::Float ratedPowerFactor
 Power factor (nameplate data). It is primarily used for short circuit data exchange according to IEC 60909. The attribute cannot be a negative value. Default: 0.0.
CIMPP::ApparentPower ratedS
 Nameplate apparent power rating for the unit. The attribute shall have a positive value. Default: 0.0.
CIMPP::Voltage ratedU
 Rated voltage (nameplate data, Ur in IEC 60909-0). It is primarily used for short circuit data exchange according to IEC 60909. The attribute shall be a positive value. 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 [] = "SynchronousMachine"
Static Public Attributes inherited from CIMPP::RotatingMachine
static const char debugName [] = "RotatingMachine"
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

An electromechanical device that operates with shaft rotating synchronously with the network. It is a single machine operating either as a generator or synchronous condenser or pump.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::RotatingMachine.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::RotatingMachine.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::RotatingMachine.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::RotatingMachine.

◆ debugString()

const char * SynchronousMachine::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::RotatingMachine.

◆ getAttributeNames()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::RotatingMachine.

◆ getRecommendedProfile()

const CGMESProfile & SynchronousMachine::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::RotatingMachine.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::RotatingMachine.

Member Data Documentation

◆ satDirectSyncX

CIMPP::PU CIMPP::SynchronousMachine::satDirectSyncX

Direct-axis subtransient reactance saturated, also known as Xd`sat. Default: 0.0 */ CIMPP::PU satDirectSubtransX;.

/** Direct-axes saturated synchronous reactance (xdsat); reciprocal of short-circuit ration. Used for short circuit data exchange, only for single fed short circuit on a generator. (4.3.4.2. in IEC 60909-0:2001). Default: 0.0


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