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

An object that defines one or more points in a given space. This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines. More...

#include <DiagramObject.hpp>

Inheritance diagram for CIMPP::DiagramObject:
Collaboration diagram for CIMPP::DiagramObject:

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::IdentifiedObject
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::Diagram * Diagram
 A diagram object is part of a diagram. Default: nullptr.
std::list< CIMPP::DiagramObjectPoint * > DiagramObjectPoints
 A diagram object can have 0 or more points to reflect its layout position, routing (for polylines) or boundary (for polygons). Default: {}.
CIMPP::DiagramObjectStyle * DiagramObjectStyle
 A diagram object has a style associated that provides a reference for the style used in the originating system. Default: nullptr.
CIMPP::IdentifiedObject * IdentifiedObject
 The domain object to which this diagram object is associated. Default: nullptr.
std::list< CIMPP::VisibilityLayer * > VisibilityLayers
 A diagram object can be part of multiple visibility layers. Default: {}.
CIMPP::Integer drawingOrder
 The drawing order of this element. The higher the number, the later the element is drawn in sequence. This is used to ensure that elements that overlap are rendered in the correct order. Default: 0.
CIMPP::Boolean isPolygon
 Defines whether or not the diagram objects points define the boundaries of a polygon or the routing of a polyline. If this value is true then a receiving application should consider the first and last points to be connected. Default: false.
CIMPP::Float offsetX
 The offset in the X direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the horizontal centre of the icon. -0.5 indicates it is offset by 50% to the left and 0.5 indicates an offset of 50% to the right. Default: 0.0.
CIMPP::Float offsetY
 The offset in the Y direction. This is used for defining the offset from centre for rendering an icon (the default is that a single point specifies the centre of the icon). The offset is in per-unit with 0 indicating there is no offset from the vertical centre of the icon. The offset direction is dependent on the orientation of the diagram, with -0.5 and 0.5 indicating an offset of +/- 50% on the vertical axis. Default: 0.0.
CIMPP::AngleDegrees rotation
 Sets the angle of rotation of the diagram object. Zero degrees is pointing to the top of the diagram. Rotation is clockwise. DiagramObject.rotation=0 has the following meaning: The connection point of an element which has one terminal is pointing to the top side of the diagram. The connection point From side of an element which has more than one terminal is pointing to the top side of the diagram. DiagramObject.rotation=90 has the following meaning: The connection point of an element which has one terminal is pointing to the right hand side of the diagram. The connection point From side of an element which has more than one terminal is pointing to the right hand side of the diagram. Default: 0.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 [] = "DiagramObject"
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::IdentifiedObject
std::map< std::string, AttrDetails > allAttrDetailsMap () const override

Detailed Description

An object that defines one or more points in a given space. This object can be associated with anything that specializes IdentifiedObject. For single line diagrams such objects typically include such items as analog values, breakers, disconnectors, power transformers, and transmission lines.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

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

Reimplemented from BaseClass.

◆ debugString()

const char * DiagramObject::debugString ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

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

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & DiagramObject::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

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

Reimplemented from BaseClass.


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