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

For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state). For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses". More...

#include <TopologicalNode.hpp>

Inheritance diagram for CIMPP::TopologicalNode:
Collaboration diagram for CIMPP::TopologicalNode:

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::TopologicalIsland * AngleRefTopologicalIsland
 The island for which the node is an angle reference. Normally there is one angle reference node for each island. Default: nullptr.
CIMPP::BaseVoltage * BaseVoltage
 The base voltage of the topological node. Default: nullptr.
CIMPP::ConnectivityNodeContainer * ConnectivityNodeContainer
 The connectivity node container to which the topological node belongs. Default: nullptr.
std::list< CIMPP::ConnectivityNode * > ConnectivityNodes
 The connectivity nodes combine together to form this topological node. May depend on the current state of switches in the network. Default: {}.
CIMPP::ReportingGroup * ReportingGroup
 The reporting group to which the topological node belongs. Default: nullptr.
CIMPP::SvInjection * SvInjection
 The injection flows state variables associated with the topological node. Default: nullptr.
CIMPP::SvVoltage * SvVoltage
 The state voltage associated with the topological node. Default: nullptr.
std::list< CIMPP::Terminal * > Terminal
 The terminals associated with the topological node. This can be used as an alternative to the connectivity node path to terminal, thus making it unnecessary to model connectivity nodes in some cases. Note that if connectivity nodes are in the model, this association would probably not be used as an input specification. Default: {}.
CIMPP::TopologicalIsland * TopologicalIsland
 A topological node belongs to a topological island. Default: nullptr.
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 [] = "TopologicalNode"
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

For a detailed substation model a topological node is a set of connectivity nodes that, in the current network state, are connected together through any type of closed switches, including jumpers. Topological nodes change as the current network state changes (i.e., switches, breakers, etc. change state). For a planning model, switch statuses are not used to form topological nodes. Instead they are manually created or deleted in a model builder tool. Topological nodes maintained this way are also called "busses".

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ debugString()

const char * TopologicalNode::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::IdentifiedObject.

◆ getAttributeNames()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::IdentifiedObject.

◆ getRecommendedProfile()

const CGMESProfile & TopologicalNode::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::IdentifiedObject.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::IdentifiedObject.


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