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

An AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes. More...

#include <Terminal.hpp>

Inheritance diagram for CIMPP::Terminal:
Collaboration diagram for CIMPP::Terminal:

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::ACDCTerminal
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::AuxiliaryEquipment * > AuxiliaryEquipment
 The auxiliary equipment connected to the terminal. Default: {}.
CIMPP::ConductingEquipment * ConductingEquipment
 The conducting equipment of the terminal. Conducting equipment have terminals that may be connected to other conducting equipment terminals via connectivity nodes or topological nodes. Default: nullptr.
CIMPP::ConnectivityNode * ConnectivityNode
 The connectivity node to which this terminal connects with zero impedance. Default: nullptr.
std::list< CIMPP::MutualCoupling * > HasFirstMutualCoupling
 All converters` DC sides linked to this point of common coupling terminal. Default: {} */ std::list<CIMPP::ACDCConverter*> ConverterDCSides;.
std::list< CIMPP::MutualCoupling * > HasSecondMutualCoupling
 Mutual couplings with the branch associated as the first branch. Default: {}.
std::list< CIMPP::RegulatingControl * > RegulatingControl
 The controls regulating this terminal. Default: {}.
std::list< CIMPP::RemoteInputSignal * > RemoteInputSignal
 Input signal coming from this terminal. Default: {}.
CIMPP::SvPowerFlow * SvPowerFlow
 The power flow state variable associated with the terminal. Default: nullptr.
std::list< CIMPP::TieFlow * > TieFlow
 The control area tie flows to which this terminal associates. Default: {}.
CIMPP::TopologicalNode * TopologicalNode
 The topological node associated with the terminal. This can be used as an alternative to the connectivity node path to topological node, thus making it unnecessary to model connectivity nodes in some cases. Note that the if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: nullptr.
std::list< CIMPP::TransformerEnd * > TransformerEnd
 All transformer ends connected at this terminal. Default: {}.
CIMPP::PhaseCode phases
 Represents the normal network phasing condition. If the attribute is missing, three phases (ABC) shall be assumed, except for terminals of grounding classes (specializations of EarthFaultCompensator, GroundDisconnector, and Ground) which will be assumed to be N. Therefore, phase code ABCN is explicitly declared when needed, e.g. for star point grounding equipment. The phase code on terminals connecting same ConnectivityNode or same TopologicalNode as well as for equipment between two terminals shall be consistent. Default: 0.
Public Attributes inherited from CIMPP::ACDCTerminal
CIMPP::BusNameMarker * BusNameMarker
 The bus name marker used to name the bus (topological node). Default: nullptr.
std::list< CIMPP::Measurement * > Measurements
 Measurements associated with this terminal defining where the measurement is placed in the network topology. It may be used, for instance, to capture the sensor position, such as a voltage transformer (PT) at a busbar or a current transformer (CT) at the bar between a breaker and an isolator. Default: {}.
std::list< CIMPP::OperationalLimitSet * > OperationalLimitSet
 The operational limit sets at the terminal. Default: {}.
CIMPP::Boolean connected
 The connected status is related to a bus-branch model and the topological node to terminal relation. True implies the terminal is connected to the related topological node and false implies it is not. In a bus-branch model, the connected status is used to tell if equipment is disconnected without having to change the connectivity described by the topological node to terminal relation. A valid case is that conducting equipment can be connected in one end and open in the other. In particular for an AC line segment, where the reactive line charging can be significant, this is a relevant case. Default: false.
CIMPP::Integer sequenceNumber
 The orientation of the terminal connections for a multiple terminal conducting equipment. The sequence numbering starts with 1 and additional terminals should follow in increasing order. The first terminal is the starting point for a two terminal branch. Default: 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 [] = "Terminal"
Static Public Attributes inherited from CIMPP::ACDCTerminal
static const char debugName [] = "ACDCTerminal"
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 AC electrical connection point to a piece of conducting equipment. Terminals are connected at physical connection points called connectivity nodes.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ debugString()

const char * Terminal::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::ACDCTerminal.

◆ getAttributeNames()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::ACDCTerminal.

◆ getRecommendedProfile()

const CGMESProfile & Terminal::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::ACDCTerminal.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::ACDCTerminal.

Member Data Documentation

◆ HasFirstMutualCoupling

std::list<CIMPP::MutualCoupling*> CIMPP::Terminal::HasFirstMutualCoupling

All converters` DC sides linked to this point of common coupling terminal. Default: {} */ std::list<CIMPP::ACDCConverter*> ConverterDCSides;.

/** Mutual couplings associated with the branch as the first branch. Default: {}


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