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

Time point for a schedule where the time between the consecutive points is constant. More...

#include <RegularTimePoint.hpp>

Inheritance diagram for CIMPP::RegularTimePoint:
Collaboration diagram for CIMPP::RegularTimePoint:

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::RegularIntervalSchedule * IntervalSchedule
 Regular interval schedule containing this time point. Default: nullptr.
CIMPP::Integer sequenceNumber
 The position of the regular time point in the sequence. Note that time points dont have to be sequential, i.e. time points may be omitted. The actual time for a RegularTimePoint is computed by multiplying the associated regular interval schedules time step with the regular time point sequence number and adding the associated schedules start time. To specify values for the start time, use sequence number 0. The sequence number cannot be negative. Default: 0.
CIMPP::Float value1
 The first value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0.
CIMPP::Float value2
 The second value at the time. The meaning of the value is defined by the derived type of the associated schedule. Default: 0.0.

Static Public Attributes

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

Protected Member Functions

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

Detailed Description

Time point for a schedule where the time between the consecutive points is constant.

Member Function Documentation

◆ addClassGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addEnumGetFnsToMap()

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

Reimplemented from BaseClass.

◆ addPrimitiveGetFnsToMap()

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

Reimplemented from BaseClass.

◆ allAttrDetailsMap()

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

Reimplemented from BaseClass.

◆ debugString()

const char * RegularTimePoint::debugString ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ getAttributeNames()

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

Reimplemented from BaseClass.

◆ getAttributeNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getClassNamespaceUrl()

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

Reimplemented from BaseClass.

◆ getPossibleAttributeProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfiles()

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

Reimplemented from BaseClass.

◆ getPossibleProfilesIncludingAttributes()

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

Reimplemented from BaseClass.

◆ getRecommendedProfile()

const CGMESProfile & RegularTimePoint::getRecommendedProfile ( ) const
overridevirtual

Reimplemented from BaseClass.

◆ isAssignableFrom()

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

Reimplemented from BaseClass.


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