- 3.0.2 core module.
ct::core::Observer< STATE_DIM, SCALAR > Class Template Reference

Observer for Integrator. More...

#include <Observer.h>

Public Types

typedef std::vector< std::shared_ptr< EventHandler< STATE_DIM, SCALAR > >, Eigen::aligned_allocator< std::shared_ptr< EventHandler< STATE_DIM, SCALAR > > > > EventHandlerPtrVector
 

Public Member Functions

 Observer (const EventHandlerPtrVector &eventHandlers)
 default constructor More...
 
void reset ()
 reset the observer More...
 
void observe (const StateVector< STATE_DIM, SCALAR > &x, const SCALAR &t)
 
void log (const StateVector< STATE_DIM, SCALAR > &x, const SCALAR &t)
 
void observeInternal (const StateVector< STATE_DIM, SCALAR > &x, const SCALAR &t)
 

Friends

class Integrator< STATE_DIM, SCALAR >
 

Detailed Description

template<size_t STATE_DIM, typename SCALAR = double>
class ct::core::Observer< STATE_DIM, SCALAR >

Observer for Integrator.

Implements a general observer as required by boost::odeint. This wraps all event handlers and calls them. Furthermore, this class records state and time trajectories during integration.

Template Parameters
STATE_DIMThe size of the state vector

Member Typedef Documentation

◆ EventHandlerPtrVector

template<size_t STATE_DIM, typename SCALAR = double>
typedef std::vector<std::shared_ptr<EventHandler<STATE_DIM, SCALAR> >, Eigen::aligned_allocator<std::shared_ptr<EventHandler<STATE_DIM, SCALAR> > > > ct::core::Observer< STATE_DIM, SCALAR >::EventHandlerPtrVector

Constructor & Destructor Documentation

◆ Observer()

template<size_t STATE_DIM, typename SCALAR >
ct::core::Observer< STATE_DIM, SCALAR >::Observer ( const EventHandlerPtrVector eventHandlers)

default constructor

Parameters
eventHandlersvector of event handlers

Member Function Documentation

◆ reset()

template<size_t STATE_DIM, typename SCALAR >
void ct::core::Observer< STATE_DIM, SCALAR >::reset ( )

◆ observe()

template<size_t STATE_DIM, typename SCALAR>
void ct::core::Observer< STATE_DIM, SCALAR >::observe ( const StateVector< STATE_DIM, SCALAR > &  x,
const SCALAR t 
)

◆ log()

template<size_t STATE_DIM, typename SCALAR>
void ct::core::Observer< STATE_DIM, SCALAR >::log ( const StateVector< STATE_DIM, SCALAR > &  x,
const SCALAR t 
)

◆ observeInternal()

template<size_t STATE_DIM, typename SCALAR>
void ct::core::Observer< STATE_DIM, SCALAR >::observeInternal ( const StateVector< STATE_DIM, SCALAR > &  x,
const SCALAR t 
)

Friends And Related Function Documentation

◆ Integrator< STATE_DIM, SCALAR >

template<size_t STATE_DIM, typename SCALAR = double>
friend class Integrator< STATE_DIM, SCALAR >
friend

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