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

An analog control that issues a set point value. More...

#include <SetPoint.hpp>

Inheritance diagram for CIMPP::SetPoint:
Collaboration diagram for CIMPP::SetPoint:

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::AnalogControl
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::Control
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::Float normalValue
 Normal value for Control.value e.g. used for percentage scaling. Default: 0.0.
CIMPP::Float value
 The value representing the actuator output. Default: 0.0.
Public Attributes inherited from CIMPP::AnalogControl
CIMPP::AnalogValue * AnalogValue
 The MeasurementValue that is controlled. Default: nullptr.
CIMPP::Float maxValue
 Normal value range maximum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0.
CIMPP::Float minValue
 Normal value range minimum for any of the Control.value. Used for scaling, e.g. in bar graphs. Default: 0.0.
Public Attributes inherited from CIMPP::Control
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 [] = "SetPoint"
Static Public Attributes inherited from CIMPP::AnalogControl
static const char debugName [] = "AnalogControl"
Static Public Attributes inherited from CIMPP::Control
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

Detailed Description

An analog control that issues a set point value.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::AnalogControl.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::AnalogControl.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::AnalogControl.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::AnalogControl.

◆ debugString()

const char * SetPoint::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::AnalogControl.

◆ getAttributeNames()

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

Reimplemented from CIMPP::AnalogControl.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::AnalogControl.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::AnalogControl.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::AnalogControl.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::AnalogControl.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::AnalogControl.

◆ getRecommendedProfile()

const CGMESProfile & SetPoint::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::AnalogControl.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::AnalogControl.


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