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

This class represents the zero sequence line mutual coupling. More...

#include <MutualCoupling.hpp>

Inheritance diagram for CIMPP::MutualCoupling:
Inheritance graph
[legend]
Collaboration diagram for CIMPP::MutualCoupling:
Collaboration graph
[legend]

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::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::Terminal * First_Terminal
 The starting terminal for the calculation of distances along the first branch of the mutual coupling. Normally MutualCoupling would only be used for terminals of AC line segments. The first and second terminals of a mutual coupling should point to different AC line segments. Default: nullptr.
CIMPP::Terminal * Second_Terminal
 The starting terminal for the calculation of distances along the second branch of the mutual coupling. Default: nullptr.
CIMPP::Susceptance b0ch
 Zero sequence mutual coupling shunt (charging) susceptance, uniformly distributed, of the entire line section. Default: 0.0.
CIMPP::Conductance g0ch
 Distance to the start of the coupled region from the first line`s terminal having sequence number equal to 1. Default: 0.0 */ CIMPP::Length distance11;.
CIMPP::Resistance r0
 Zero sequence branch-to-branch mutual impedance coupling, resistance. Default: 0.0.
CIMPP::Reactance x0
 Zero sequence branch-to-branch mutual impedance coupling, reactance. Default: 0.0.
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 [] = "MutualCoupling"
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

This class represents the zero sequence line mutual coupling.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ debugString()

const char * MutualCoupling::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::IdentifiedObject.

◆ getAttributeNames()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getRecommendedProfile()

const CGMESProfile & MutualCoupling::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::IdentifiedObject.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::IdentifiedObject.

Member Data Documentation

◆ g0ch

CIMPP::Conductance CIMPP::MutualCoupling::g0ch

Distance to the start of the coupled region from the first line`s terminal having sequence number equal to 1. Default: 0.0 */ CIMPP::Length distance11;.

/** Distance to the end of the coupled region from the first line`s terminal with sequence number equal to 1. Default: 0.0 */ CIMPP::Length distance12;

/** Distance to the start of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 */ CIMPP::Length distance21;

/** Distance to the end of coupled region from the second line`s terminal with sequence number equal to 1. Default: 0.0 */ CIMPP::Length distance22;

/** Zero sequence mutual coupling shunt (charging) conductance, uniformly distributed, of the entire line section. Default: 0.0

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