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

A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics. More...

#include <Substation.hpp>

Inheritance diagram for CIMPP::Substation:
Collaboration diagram for CIMPP::Substation:

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::EquipmentContainer
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::ConnectivityNodeContainer
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

std::list< CIMPP::DCConverterUnit * > DCConverterUnit
 The DC converter unit belonging of the substation. Default: {}.
CIMPP::SubGeographicalRegion * Region
 The SubGeographicalRegion containing the substation. Default: nullptr.
std::list< CIMPP::VoltageLevel * > VoltageLevels
 The voltage levels within this substation. Default: {}.
Public Attributes inherited from CIMPP::EquipmentContainer
std::list< CIMPP::Equipment * > Equipments
 Contained equipment. Default: {}.
Public Attributes inherited from CIMPP::ConnectivityNodeContainer
std::list< CIMPP::ConnectivityNode * > ConnectivityNodes
 Connectivity nodes which belong to this connectivity node container. Default: {}.
std::list< CIMPP::TopologicalNode * > TopologicalNode
 The topological nodes which belong to this connectivity node container. Default: {}.
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 [] = "Substation"
Static Public Attributes inherited from CIMPP::EquipmentContainer
static const char debugName [] = "EquipmentContainer"
Static Public Attributes inherited from CIMPP::ConnectivityNodeContainer
static const char debugName [] = "ConnectivityNodeContainer"
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

A collection of equipment for purposes other than generation or utilization, through which electric energy in bulk is passed for the purposes of switching or modifying its characteristics.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ debugString()

const char * Substation::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::EquipmentContainer.

◆ getAttributeNames()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::EquipmentContainer.

◆ getRecommendedProfile()

const CGMESProfile & Substation::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::EquipmentContainer.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::EquipmentContainer.


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