Public Member Functions | Public Attributes | Protected Attributes | List of all members
dynamicgraph::sot::IntegratorAbstract< sigT, coefT > Class Template Referenceabstract

integrates an ODE. If Y is the output and X the input, the following equation is integrated: a_p * d(p)Y / dt^p + .... + a_0 Y = b_m * d(m)X / dt^m + ... . b_0 X a_i are the coefficients of the denominator of the associated transfer function between X and Y, while the b_i are those of the numerator. More...

#include <integrator-abstract.hh>

Inheritance diagram for dynamicgraph::sot::IntegratorAbstract< sigT, coefT >:
Inheritance graph
[legend]

Public Member Functions

const std::vector< coefT > & denomCoeffs () const
 
void denomCoeffs (const std::vector< coefT > &coeffs)
 
virtual void display (std::ostream &os) const
 
virtual sigT & integrate (sigT &res, int time)=0
 
 IntegratorAbstract (const std::string &name)
 
const std::vector< coefT > & numCoeffs () const
 
void numCoeffs (const std::vector< coefT > &coeffs)
 
void popDenomCoef ()
 
void popNumCoef ()
 
void pushDenomCoef (const coefT &denomCoef)
 
void pushNumCoef (const coefT &numCoef)
 
virtual ~IntegratorAbstract ()
 
- Public Member Functions inherited from dynamicgraph::Entity
std::ostream & displaySignalList (std::ostream &os) const
 
 Entity (const std::string &name)
 
virtual const std::string & getClassName () const
 
const std::string & getCommandList () const
 
virtual std::string getDocString () const
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
const std::string & getName () const
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 
CommandMap_t getNewStyleCommandMap ()
 
SignalBase< int > & getSignal (const std::string &signalName)
 
const SignalBase< int > & getSignal (const std::string &signalName) const
 
SignalMap getSignalMap () const
 
double getStreamPrintPeriod ()
 
double getStreamPrintPeriod ()
 
double getTimeSample ()
 
double getTimeSample ()
 
bool hasSignal (const std::string &signame) const
 
Loggerlogger ()
 
Logger const & logger () const
 
Loggerlogger ()
 
Logger const & logger () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
bool setStreamPrintPeriod (double t)
 
bool setStreamPrintPeriod (double t)
 
bool setTimeSample (double t)
 
bool setTimeSample (double t)
 
virtual SignalBase< int > * test ()
 
virtual void test2 (SignalBase< int > *)
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual ~Entity ()
 

Public Attributes

dynamicgraph::SignalPtr< sigT, int > SIN
 
dynamicgraph::SignalTimeDependent< sigT, int > SOUT
 

Protected Attributes

std::vector< coefT > denominator
 
std::vector< coefT > numerator
 
- Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t commandMap
 
Logger logger_
 
std::string name
 
SignalMap signalMap
 

Additional Inherited Members

- Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command *> CommandMap_t
 
typedef std::map< std::string, SignalBase< int > *> SignalMap
 
- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 
void entityDeregistration ()
 
void entityRegistration ()
 
void signalDeregistration (const std::string &name)
 
void signalRegistration (const SignalArray< int > &signals)
 

Detailed Description

template<class sigT, class coefT>
class dynamicgraph::sot::IntegratorAbstract< sigT, coefT >

integrates an ODE. If Y is the output and X the input, the following equation is integrated: a_p * d(p)Y / dt^p + .... + a_0 Y = b_m * d(m)X / dt^m + ... . b_0 X a_i are the coefficients of the denominator of the associated transfer function between X and Y, while the b_i are those of the numerator.

Definition at line 46 of file integrator-abstract.hh.

Constructor & Destructor Documentation

◆ IntegratorAbstract()

template<class sigT , class coefT >
dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::IntegratorAbstract ( const std::string &  name)
inline

Definition at line 48 of file integrator-abstract.hh.

◆ ~IntegratorAbstract()

template<class sigT , class coefT >
virtual dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::~IntegratorAbstract ( )
inlinevirtual

Definition at line 82 of file integrator-abstract.hh.

Member Function Documentation

◆ denomCoeffs() [1/2]

template<class sigT , class coefT >
const std::vector<coefT>& dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::denomCoeffs ( ) const
inline

Definition at line 97 of file integrator-abstract.hh.

◆ denomCoeffs() [2/2]

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::denomCoeffs ( const std::vector< coefT > &  coeffs)
inline

Definition at line 98 of file integrator-abstract.hh.

◆ display()

template<class sigT , class coefT >
virtual void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::display ( std::ostream &  os) const
inlinevirtual

Reimplemented from dynamicgraph::Entity.

Definition at line 105 of file integrator-abstract.hh.

◆ integrate()

template<class sigT , class coefT >
virtual sigT& dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::integrate ( sigT &  res,
int  time 
)
pure virtual

◆ numCoeffs() [1/2]

template<class sigT , class coefT >
const std::vector<coefT>& dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::numCoeffs ( ) const
inline

Definition at line 94 of file integrator-abstract.hh.

◆ numCoeffs() [2/2]

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::numCoeffs ( const std::vector< coefT > &  coeffs)
inline

Definition at line 95 of file integrator-abstract.hh.

◆ popDenomCoef()

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::popDenomCoef ( )
inline

Definition at line 92 of file integrator-abstract.hh.

◆ popNumCoef()

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::popNumCoef ( )
inline

Definition at line 91 of file integrator-abstract.hh.

◆ pushDenomCoef()

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::pushDenomCoef ( const coefT &  denomCoef)
inline

Definition at line 88 of file integrator-abstract.hh.

◆ pushNumCoef()

template<class sigT , class coefT >
void dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::pushNumCoef ( const coefT &  numCoef)
inline

Definition at line 87 of file integrator-abstract.hh.

Member Data Documentation

◆ denominator

template<class sigT , class coefT >
std::vector<coefT> dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::denominator
protected

Definition at line 121 of file integrator-abstract.hh.

◆ numerator

template<class sigT , class coefT >
std::vector<coefT> dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::numerator
protected

Definition at line 120 of file integrator-abstract.hh.

◆ SIN

template<class sigT , class coefT >
dynamicgraph::SignalPtr<sigT, int> dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::SIN

Definition at line 101 of file integrator-abstract.hh.

◆ SOUT

template<class sigT , class coefT >
dynamicgraph::SignalTimeDependent<sigT, int> dynamicgraph::sot::IntegratorAbstract< sigT, coefT >::SOUT

Definition at line 103 of file integrator-abstract.hh.


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


sot-core
Author(s): Olivier Stasse, ostasse@laas.fr
autogenerated on Wed Jun 21 2023 02:51:27