Control is used for supervisory/device control. It represents control outputs that are used to change the state in a process, e.g. close or open breaker, a set point value or a raise lower command. More...

#include <Control.hpp>

Inheritance diagram for CIMPP::Control:

[legend]

Collaboration diagram for CIMPP::Control:

[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::IOPoint
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::IOPoint
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::PowerSystemResource *	PowerSystemResource
	Regulating device governed by this control output. Default: nullptr.
CIMPP::String	controlType
	Specifies the type of Control. For example, this specifies if the Control represents BreakerOpen, BreakerClose, GeneratorVoltageSetPoint, GeneratorRaise, GeneratorLower, etc. Default: "".
CIMPP::Boolean	operationInProgress
	Indicates that a client is currently sending control commands that has not completed. Default: false.
CIMPP::DateTime	timeStamp
	The last time a control output was sent. Default: "".
CIMPP::UnitMultiplier	unitMultiplier
	The unit multiplier of the controlled quantity. Default: 0.
CIMPP::UnitSymbol	unitSymbol
	The unit of measure of the controlled quantity. Default: 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 [] = "Control"
Static Public Attributes inherited from CIMPP::IOPoint
static const char	debugName [] = "IOPoint"
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::IOPoint
std::map< std::string, AttrDetails >	allAttrDetailsMap () const override

Detailed Description

Control is used for supervisory/device control. It represents control outputs that are used to change the state in a process, e.g. close or open breaker, a set point value or a raise lower command.

Member Function Documentation

◆ addClassGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

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

overridevirtual

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

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

overrideprotectedvirtual

Reimplemented from BaseClass.

◆ debugString()

const char * Control::debugString ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

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

overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

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

overridevirtual

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

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

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

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

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfiles()

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

overridevirtual

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

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

overridevirtual

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & Control::getRecommendedProfile ( ) const

overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

bool Control::isAssignableFrom ( BaseClass * otherObject ) const

overridevirtual

Reimplemented from BaseClass.

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

CGMES_3.0.0/Control.hpp
CGMES_3.0.0/Control.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()