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

A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal. More...

#include <Connector.hpp>

Inheritance diagram for CIMPP::Connector:
Collaboration diagram for CIMPP::Connector:

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 CIMPP::Equipment
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 CIMPP::PowerSystemResource
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::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 ()

Static Public Attributes

static const char debugName [] = "Connector"
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
Protected Member Functions inherited from CIMPP::Equipment
std::map< std::string, AttrDetails > allAttrDetailsMap () const override
Protected Member Functions inherited from CIMPP::PowerSystemResource
std::map< std::string, AttrDetails > allAttrDetailsMap () const override

Additional Inherited Members

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: "".

Detailed Description

A conductor, or group of conductors, with negligible impedance, that serve to connect other conducting equipment within a single substation and are modelled with a single logical terminal.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ debugString()

const char * Connector::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::ConductingEquipment.

◆ getAttributeNames()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::ConductingEquipment.

◆ getRecommendedProfile()

const CGMESProfile & Connector::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::ConductingEquipment.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::ConductingEquipment.


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