Bayes Filters Library
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
bfl::ExogenousModel Class Referenceabstract

#include <ExogenousModel.h>

Inheritance diagram for bfl::ExogenousModel:
[legend]

Public Member Functions

virtual ~ExogenousModel () noexcept=default
 
bool skip (const std::string &what_step, const bool status) override
 
bool is_skipping () override
 
virtual void propagate (const Eigen::Ref< const Eigen::MatrixXd > &cur_states, Eigen::Ref< Eigen::MatrixXd > prop_states)=0
 
virtual bool setProperty (const std::string &property)=0
 
virtual VectorDescription getStateDescription () const =0
 Returns the vector description of the output of the state equation. More...
 

Protected Member Functions

 ExogenousModel () noexcept=default
 
 ExogenousModel (const ExogenousModel &exogenous_model) noexcept=delete
 
ExogenousModeloperator= (const ExogenousModel &exogenous_model) noexcept=delete
 
 ExogenousModel (ExogenousModel &&exogenous_model) noexcept=default
 
ExogenousModeloperator= (ExogenousModel &&exogenous_model) noexcept=default
 

Private Attributes

bool skip_ = false
 Skip status. More...
 

Detailed Description

Definition at line 19 of file ExogenousModel.h.

Constructor & Destructor Documentation

◆ ~ExogenousModel()

virtual bfl::ExogenousModel::~ExogenousModel ( )
virtualdefaultnoexcept

◆ ExogenousModel() [1/3]

bfl::ExogenousModel::ExogenousModel ( )
protecteddefaultnoexcept

◆ ExogenousModel() [2/3]

bfl::ExogenousModel::ExogenousModel ( const ExogenousModel exogenous_model)
protecteddeletenoexcept

◆ ExogenousModel() [3/3]

bfl::ExogenousModel::ExogenousModel ( ExogenousModel &&  exogenous_model)
protecteddefaultnoexcept

Member Function Documentation

◆ getStateDescription()

virtual VectorDescription bfl::ExogenousProcess::getStateDescription ( ) const
pure virtualinherited

Returns the vector description of the output of the state equation.

◆ is_skipping()

bool ExogenousModel::is_skipping ( )
overridevirtual

Implements bfl::Skippable.

Definition at line 25 of file ExogenousModel.cpp.

◆ operator=() [1/2]

ExogenousModel& bfl::ExogenousModel::operator= ( const ExogenousModel exogenous_model)
protecteddeletenoexcept

◆ operator=() [2/2]

ExogenousModel& bfl::ExogenousModel::operator= ( ExogenousModel &&  exogenous_model)
protecteddefaultnoexcept

◆ propagate()

virtual void bfl::ExogenousProcess::propagate ( const Eigen::Ref< const Eigen::MatrixXd > &  cur_states,
Eigen::Ref< Eigen::MatrixXd >  prop_states 
)
pure virtualinherited

◆ setProperty()

virtual bool bfl::ExogenousProcess::setProperty ( const std::string &  property)
pure virtualinherited

◆ skip()

bool ExogenousModel::skip ( const std::string &  what_step,
const bool  status 
)
overridevirtual

Implements bfl::Skipper.

Definition at line 14 of file ExogenousModel.cpp.

Member Data Documentation

◆ skip_

bool bfl::ExogenousModel::skip_ = false
private

Skip status.

Definition at line 45 of file ExogenousModel.h.


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