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

Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models. This class does not inherit from IdentifiedObject since it is not intended that a single instance of it be referenced by more than one proprietary user-defined model instance. More...

#include <ProprietaryParameterDynamics.hpp>

Inheritance diagram for CIMPP::ProprietaryParameterDynamics:
Collaboration diagram for CIMPP::ProprietaryParameterDynamics:

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 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::AsynchronousMachineUserDefined * AsynchronousMachineUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::CSCUserDefined * CSCUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::DiscontinuousExcitationControlUserDefined * DiscontinuousExcitationControlUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::ExcitationSystemUserDefined * ExcitationSystemUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::LoadUserDefined * LoadUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::MechanicalLoadUserDefined * MechanicalLoadUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::OverexcitationLimiterUserDefined * OverexcitationLimiterUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::PFVArControllerType1UserDefined * PFVArControllerType1UserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::PFVArControllerType2UserDefined * PFVArControllerType2UserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::PowerSystemStabilizerUserDefined * PowerSystemStabilizerUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::SVCUserDefined * SVCUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::SynchronousMachineUserDefined * SynchronousMachineUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::TurbineGovernorUserDefined * TurbineGovernorUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::TurbineLoadControllerUserDefined * TurbineLoadControllerUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::UnderexcitationLimiterUserDefined * UnderexcitationLimiterUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::VSCUserDefined * VSCUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::VoltageAdjusterUserDefined * VoltageAdjusterUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::VoltageCompensatorUserDefined * VoltageCompensatorUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::WindPlantUserDefined * WindPlantUserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::WindType1or2UserDefined * WindType1or2UserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::WindType3or4UserDefined * WindType3or4UserDefined
 Proprietary user-defined model with which this parameter is associated. Default: nullptr.
CIMPP::Boolean booleanParameterValue
 Boolean parameter value. If this attribute is populated, integerParameterValue and floatParameterValue will not be. Default: false.
CIMPP::Float floatParameterValue
 Floating point parameter value. If this attribute is populated, booleanParameterValue and integerParameterValue will not be. Default: 0.0.
CIMPP::Integer integerParameterValue
 Integer parameter value. If this attribute is populated, booleanParameterValue and floatParameterValue will not be. Default: 0.
CIMPP::Integer parameterNumber
 Sequence number of the parameter among the set of parameters associated with the related proprietary user-defined model. Default: 0.

Static Public Attributes

static const char debugName [] = "ProprietaryParameterDynamics"
Static Public Attributes inherited from BaseClass
static const char debugName [] = "BaseClass"

Protected Member Functions

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

Detailed Description

Supports definition of one or more parameters of several different datatypes for use by proprietary user-defined models. This class does not inherit from IdentifiedObject since it is not intended that a single instance of it be referenced by more than one proprietary user-defined model instance.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

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

Reimplemented from BaseClass.

◆ debugString()

const char * ProprietaryParameterDynamics::debugString ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

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

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & ProprietaryParameterDynamics::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

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

Reimplemented from BaseClass.


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