SequentialFilterHistory Class Reference

#include <SequentialFilterHistory.h>

Inheritance diagram for SequentialFilterHistory:

[legend]Collaboration diagram for SequentialFilterHistory:

[legend]List of all members.

---

Detailed Description

An abstract class to store generic sequential filter data.

Definition at line 25 of file SequentialFilterHistory.h.

Public Member Functions
virtual	~SequentialFilterHistory ()
virtual void	AppendHistory (const double &_appendTime)
	Add the sequential filters's data, which occured at a time in seconds, to the history.
virtual void	AppendHistory (const ssfTime &_appendTime)
	Add the sequential filters's data, which occured at a time in seconds, to the history.
virtual void	ResetHistory ()
	Erases the sequential filters's struct history.
virtual Matrix	GetHistory ()
	Returns a matrix of the sequential filter's struct history.
virtual void	GetKalmanHistory (Matrix &, Matrix &)=0
virtual Vector	GetIterationHistory ()
virtual vector< ssfTime >::difference_type	AppendHistory (const vector< ssfTime > &_appendTime)
	Add a vector of ssfTime objects to the stored history.
virtual void	SetInterpolator (Interpolator *_newInterpolator)
	Returns the nearest stored,lower mesh point to the requested time. Sets the interpolator used for calculating the states in-between stored mesh points.
Protected Member Functions
void	InitializeSequentialFilterHistory (SequentialFilter *_ptr_filter)
	Protected initializer function. A pseudo-constuctor for this abstract class, if you will. Takes a pointer to the filter being logged; called from dervied class constructor.
vector< ssfTime >::difference_type	GetState (const ssfTime &_requestedTime)
	Returns the nearest stored,lower mesh point to the requested time.
Protected Attributes
SequentialFilter *	m_ptr_filter
	Pointer to the filter that the history is logging. Note that because this is a pointer to a base class it can be used to point to an instance of any derived class.
vector< ssfTime >	m_TimeHistory
	internal vector container of the ssfTime objects describing the state history
Interpolator *	m_OriginalInterpolator
	internal storage of the original, nominal interpolator to be copied and used for all interpolations
vector< Interpolator * >	m_TimeInterpolations
	internal vector of time interpolations
Private Attributes
vector< Vector >	m_sfStateHistory
	Internal vector container of the state Vector, x.
vector< Vector >	m_sfControlHistory
	Internal vector container of the control Vector, u.
vector< Vector >	m_sfMeasurementHistory
	Internal vector container of the measurement Vector, z.
vector< Vector >	m_sfParameterHistory
	Internal vector container of the parameter Vector, w.

---

Constructor & Destructor Documentation

virtual SequentialFilterHistory::~SequentialFilterHistory (   )  [inline, virtual]

Default destructor. Definition at line 30 of file SequentialFilterHistory.h.

---

Member Function Documentation

vector< ssfTime >::difference_type O_SESSAME::History::AppendHistory (  const vector< ssfTime > &  _appendTime  )  [virtual, inherited]

Add a vector of ssfTime objects to the stored history. if the beginning of the new time vector is earlier than any of the stored values then the time history will be erased from the overlap point and the new time vector will be appended. Parameters: _appendTime  vector of ssfTime objects to be appended. Definition at line 40 of file History.cpp. References O_SESSAME::History::m_TimeHistory.

void SequentialFilterHistory::AppendHistory (  const ssfTime &  _appendTime  )  [virtual]

Add the sequential filters's data, which occured at a time in seconds, to the history. Appends the state at t=_appendTime. if the new state occured at a time that is earlier than any of the stored values then the time history will be erased from the overlap point and the new state will be appended. Reimplemented from O_SESSAME::History. Reimplemented in IteratedExtendedKalmanFilterHistory, and KalmanFilterHistory. Definition at line 57 of file SequentialFilterHistory.cpp. References SequentialFilter::GetControlVector(), SequentialFilter::GetMeasurementVector(), SequentialFilter::GetParameterVector(), SequentialFilter::GetStateVector(), m_ptr_filter, m_sfControlHistory, m_sfMeasurementHistory, m_sfParameterHistory, and m_sfStateHistory.

void SequentialFilterHistory::AppendHistory (  const double &  _appendTime  )  [virtual]

Add the sequential filters's data, which occured at a time in seconds, to the history. Appends the state at t=_appendTime. if the new state occured at a time that is earlier than any of the stored values then the time history will be erased from the overlap point and the new state will be appended. Reimplemented from O_SESSAME::History. Reimplemented in IteratedExtendedKalmanFilterHistory, and KalmanFilterHistory. Definition at line 42 of file SequentialFilterHistory.cpp. Referenced by KalmanFilterHistory::AppendHistory(), and main().

Matrix SequentialFilterHistory::GetHistory (   )  [virtual]

Returns a matrix of the sequential filter's struct history. Returns: This function returns a matrix in the form [t_k, state(t_k), control(t_k), measurement(t_k), parameter(t_k)] Reimplemented from O_SESSAME::History. Reimplemented in KalmanFilterHistory. Definition at line 81 of file SequentialFilterHistory.cpp. References _, SequentialFilter::GetControlVector(), CAMvectorBase::getIndexBound(), SequentialFilter::GetMeasurementVector(), SequentialFilter::GetParameterVector(), SequentialFilter::GetStateVector(), m_ptr_filter, m_sfControlHistory, m_sfMeasurementHistory, m_sfParameterHistory, m_sfStateHistory, O_SESSAME::Matrix, and O_SESSAME::MatrixIndexBase. Referenced by KalmanFilterHistory::GetHistory(), KalmanFilterHistory::GetKalmanHistory(), and main().

virtual Vector SequentialFilterHistory::GetIterationHistory (   )  [inline, virtual]

Reimplemented in IteratedExtendedKalmanFilterHistory. Definition at line 41 of file SequentialFilterHistory.h. References O_SESSAME::Vector.

virtual void SequentialFilterHistory::GetKalmanHistory (  Matrix &  , Matrix &  )  [pure virtual]

Implemented in KalmanFilterHistory.

vector< ssfTime >::difference_type O_SESSAME::History::GetState (  const ssfTime &  _requestedTime  )  [protected, inherited]

Returns the nearest stored,lower mesh point to the requested time. interpolates using the specified interpolator if necessary. Parameters: _requestedTime  Desired time to retrieve the state. Used to find the nearest corresponding lower mesh point. Returns: The index of the time history vector of the nearest, lower mesh point. Reimplemented in O_SESSAME::AttitudeHistory, and O_SESSAME::OrbitHistory. Definition at line 84 of file History.cpp. References O_SESSAME::History::m_TimeHistory.

void SequentialFilterHistory::InitializeSequentialFilterHistory (  SequentialFilter *  _ptr_filter  )  [protected]

Protected initializer function. A pseudo-constuctor for this abstract class, if you will. Takes a pointer to the filter being logged; called from dervied class constructor. Definition at line 17 of file SequentialFilterHistory.cpp. References HISTORY_RESERVE_SIZE, m_ptr_filter, m_sfControlHistory, m_sfMeasurementHistory, m_sfParameterHistory, m_sfStateHistory, and ResetHistory(). Referenced by ExtendedKalmanFilterHistory::ExtendedKalmanFilterHistory(), IteratedExtendedKalmanFilterHistory::IteratedExtendedKalmanFilterHistory(), and KalmanFilterHistory::KalmanFilterHistory().

void SequentialFilterHistory::ResetHistory (   )  [virtual]

Erases the sequential filters's struct history. Reimplemented from O_SESSAME::History. Reimplemented in KalmanFilterHistory. Definition at line 74 of file SequentialFilterHistory.cpp. Referenced by InitializeSequentialFilterHistory().

void O_SESSAME::History::SetInterpolator (  Interpolator *  _newInterpolator  )  [virtual, inherited]

Returns the nearest stored,lower mesh point to the requested time. Sets the interpolator used for calculating the states in-between stored mesh points. Parameters: _newInterpolator  pointer to the interpolator that serves as the model type for all the interpolations between meshpoints. Definition at line 149 of file History.cpp. References O_SESSAME::Interpolator::Clone(), and O_SESSAME::History::m_OriginalInterpolator. Referenced by main().

---

Member Data Documentation

Interpolator* O_SESSAME::History::m_OriginalInterpolator [protected, inherited]

internal storage of the original, nominal interpolator to be copied and used for all interpolations Definition at line 131 of file History.h. Referenced by O_SESSAME::History::SetInterpolator().

SequentialFilter* SequentialFilterHistory::m_ptr_filter [protected]

Pointer to the filter that the history is logging. Note that because this is a pointer to a base class it can be used to point to an instance of any derived class. Definition at line 52 of file SequentialFilterHistory.h. Referenced by AppendHistory(), GetHistory(), and InitializeSequentialFilterHistory().

vector<Vector> SequentialFilterHistory::m_sfControlHistory [private]

Internal vector container of the control Vector, u. Definition at line 59 of file SequentialFilterHistory.h. Referenced by AppendHistory(), GetHistory(), and InitializeSequentialFilterHistory().

vector<Vector> SequentialFilterHistory::m_sfMeasurementHistory [private]

Internal vector container of the measurement Vector, z. Definition at line 62 of file SequentialFilterHistory.h. Referenced by AppendHistory(), GetHistory(), and InitializeSequentialFilterHistory().

vector<Vector> SequentialFilterHistory::m_sfParameterHistory [private]

Internal vector container of the parameter Vector, w. Definition at line 65 of file SequentialFilterHistory.h. Referenced by AppendHistory(), GetHistory(), and InitializeSequentialFilterHistory().

vector<Vector> SequentialFilterHistory::m_sfStateHistory [private]

Internal vector container of the state Vector, x. Definition at line 56 of file SequentialFilterHistory.h. Referenced by AppendHistory(), GetHistory(), and InitializeSequentialFilterHistory().

vector<ssfTime> O_SESSAME::History::m_TimeHistory [protected, inherited]

internal vector container of the ssfTime objects describing the state history Definition at line 128 of file History.h. Referenced by O_SESSAME::History::AppendHistory(), O_SESSAME::History::GetHistory(), O_SESSAME::History::GetState(), O_SESSAME::History::History(), and O_SESSAME::History::ResetHistory().

vector<Interpolator*> O_SESSAME::History::m_TimeInterpolations [protected, inherited]

internal vector of time interpolations Definition at line 134 of file History.h. Referenced by O_SESSAME::History::History().

---

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

• SequentialFilterHistory.h
• SequentialFilterHistory.cpp

---