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

Discontinuous excitation control function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>. More...

#include <DiscontinuousExcitationControlUserDefined.hpp>

Inheritance diagram for CIMPP::DiscontinuousExcitationControlUserDefined:
Inheritance graph
[legend]
Collaboration diagram for CIMPP::DiscontinuousExcitationControlUserDefined:
Collaboration graph
[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::DynamicsFunctionBlock
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::DiscontinuousExcitationControlDynamics
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::DynamicsFunctionBlock
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

std::list< CIMPP::ProprietaryParameterDynamics * > ProprietaryParameterDynamics
 Parameter of this proprietary user-defined model. Default: {}.
CIMPP::Boolean proprietary
 Behaviour is based on a proprietary model as opposed to a detailed model. true = user-defined model is proprietary with behaviour mutually understood by sending and receiving applications and parameters passed as general attributes false = user-defined model is explicitly defined in terms of control blocks and their input and output signals. Default: false.
Public Attributes inherited from CIMPP::DiscontinuousExcitationControlDynamics
CIMPP::ExcitationSystemDynamics * ExcitationSystemDynamics
 Excitation system model with which this discontinuous excitation control model is associated. Default: nullptr.
CIMPP::RemoteInputSignal * RemoteInputSignal
 Remote input signal used by this discontinuous excitation control system model. Default: nullptr.
Public Attributes inherited from CIMPP::DynamicsFunctionBlock
CIMPP::Boolean enabled
 Function block used indicator. true = use of function block is enabled false = use of function block is disabled. Default: false.
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 [] = "DiscontinuousExcitationControlUserDefined"
Static Public Attributes inherited from CIMPP::DiscontinuousExcitationControlDynamics
static const char debugName [] = "DiscontinuousExcitationControlDynamics"
Static Public Attributes inherited from CIMPP::DynamicsFunctionBlock
static const char debugName [] = "DynamicsFunctionBlock"
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::DynamicsFunctionBlock
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

Discontinuous excitation control function block whose dynamic behaviour is described by <font color="#0f0f0f">a user-defined model.</font>.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ addEnumGetFnsToMap()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ allAttrDetailsMap()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ debugString()

const char * DiscontinuousExcitationControlUserDefined::debugString ( ) const
overridevirtual

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getAttributeNames()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getAttributeNamespaceUrl()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getClassNamespaceUrl()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getPossibleAttributeProfiles()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getPossibleProfiles()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ getRecommendedProfile()

const CGMESProfile & DiscontinuousExcitationControlUserDefined::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

◆ isAssignableFrom()

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

Reimplemented from CIMPP::DiscontinuousExcitationControlDynamics.

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