Designates a connection point at which one or more model authority sets shall connect to. The location of the connection point as well as other properties are agreed between organisations responsible for the interconnection, hence all attributes of the class represent this agreement. It is primarily used in a boundary model authority set which can contain one or many BoundaryPoint-s among other Equipment-s and their connections. More...

#include <BoundaryPoint.hpp>

Inheritance diagram for CIMPP::BoundaryPoint:

[legend]

Collaboration diagram for CIMPP::BoundaryPoint:

[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 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::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
CIMPP::ConnectivityNode *	ConnectivityNode
	The connectivity node that is designated as a boundary point. Default: nullptr.
CIMPP::String	fromEndIsoCode
	The ISO code of the region which the From side of the Boundary point belongs to or it is connected to. The ISO code is a two-character country code as defined by ISO 3166 (http://www.iso.org/iso/country_codes). The length of the string is 2 characters maximum. Default: "".
CIMPP::String	fromEndName
	A human readable name with length of the string 64 characters maximum. It covers the following two cases: -if the Boundary point is placed on a tie-line, it is the name (IdentifiedObject.name) of the substation at which the From side of the tie-line is connected to. -if the Boundary point is placed in a substation, it is the name (IdentifiedObject.name) of the element (e.g. PowerTransformer, ACLineSegment, Switch, etc.) at which the From side of the Boundary point is connected to. Default: "".
CIMPP::String	fromEndNameTso
	Identifies the name of the transmission system operator, distribution system operator or other entity at which the From side of the interconnection is connected to. The length of the string is 64 characters maximum. Default: "".
CIMPP::Boolean	isDirectCurrent
	If true, this boundary point is a point of common coupling (PCC) of a direct current (DC) interconnection, otherwise the interconnection is AC (default). Default: false.
CIMPP::Boolean	isExcludedFromAreaInterchange
	If true, this boundary point is on the interconnection that is excluded from control area interchange calculation and consequently has no related tie flows. Otherwise, the interconnection is included in control area interchange and a TieFlow is required at all sides of the boundary point (default). Default: false.
CIMPP::String	toEndIsoCode
	The ISO code of the region which the To side of the Boundary point belongs to or is connected to. The ISO code is a two-character country code as defined by ISO 3166 (http://www.iso.org/iso/country_codes). The length of the string is 2 characters maximum. Default: "".
CIMPP::String	toEndName
	A human readable name with length of the string 64 characters maximum. It covers the following two cases: -if the Boundary point is placed on a tie-line, it is the name (IdentifiedObject.name) of the substation at which the To side of the tie-line is connected to. -if the Boundary point is placed in a substation, it is the name (IdentifiedObject.name) of the element (e.g. PowerTransformer, ACLineSegment, Switch, etc.) at which the To side of the Boundary point is connected to. Default: "".
CIMPP::String	toEndNameTso
	Identifies the name of the transmission system operator, distribution system operator or other entity at which the To side of the interconnection is connected to. The length of the string is 64 characters maximum. 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 [] = "BoundaryPoint"
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::PowerSystemResource
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

Designates a connection point at which one or more model authority sets shall connect to. The location of the connection point as well as other properties are agreed between organisations responsible for the interconnection, hence all attributes of the class represent this agreement. It is primarily used in a boundary model authority set which can contain one or many BoundaryPoint-s among other Equipment-s and their connections.

Member Function Documentation

◆ addClassGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

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

overrideprotectedvirtual

Reimplemented from BaseClass.

◆ debugString()

const char * BoundaryPoint::debugString ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

const std::list< std::string > & BoundaryPoint::getAttributeNames ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

const std::string & BoundaryPoint::getAttributeNamespaceUrl ( const std::string & attrName ) const

overridevirtual

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

const std::string & BoundaryPoint::getClassNamespaceUrl ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

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

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfiles()

const std::list< CGMESProfile > & BoundaryPoint::getPossibleProfiles ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

const std::list< CGMESProfile > & BoundaryPoint::getPossibleProfilesIncludingAttributes ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & BoundaryPoint::getRecommendedProfile ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

bool BoundaryPoint::isAssignableFrom ( BaseClass * otherObject ) const

overridevirtual

Reimplemented from BaseClass.

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

CGMES_3.0.0/BoundaryPoint.hpp
CGMES_3.0.0/BoundaryPoint.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ addClassGetFnsToMap()

◆ addEnumGetFnsToMap()

◆ addPrimitiveGetFnsToMap()

◆ allAttrDetailsMap()

◆ debugString()

◆ getAttributeNames()

◆ getAttributeNamespaceUrl()

◆ getClassNamespaceUrl()

◆ getPossibleAttributeProfiles()

◆ getPossibleProfiles()

◆ getPossibleProfilesIncludingAttributes()

◆ getRecommendedProfile()

◆ isAssignableFrom()