AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

animal::HistoryS< Position, Velocity > Class Template Reference

#include <history.h>

Inheritance diagram for animal::HistoryS< Position, Velocity >:

List of all members.

---

Detailed Description

template<class Position, class Velocity>
class animal::HistoryS< Position, Velocity >

History for single values with << and >> operators.

Definition at line 142 of file history.h.

Public Types
typedef History< Position, Velocity >	Parent
	parent class
typedef Parent::List	List
	implicit type inheritance is now forbidden
Public Member Functions
	HistoryS (double t, Position p, Velocity v, bool record=false)
	Constructor uses initial state, so that the history can not be empty. This initial state is used for reset.
virtual void	write (std::ostream &out) const
	Write the whole history to the given output stream.
virtual void	read (std::istream &in)
	Read the whole history from the given input stream. No comments are allowed.

---

Member Typedef Documentation

template<class Position, class Velocity> typedef Parent::List animal::HistoryS< Position, Velocity >::List

implicit type inheritance is now forbidden Reimplemented from animal::History< Position, Velocity >. Definition at line 148 of file history.h.

template<class Position, class Velocity> typedef History<Position,Velocity> animal::HistoryS< Position, Velocity >::Parent

parent class Definition at line 147 of file history.h.

---

Constructor & Destructor Documentation

template<class Position, class Velocity> animal::HistoryS< Position, Velocity >::HistoryS (  double  t, Position  p, Velocity  v, bool  record = false )  [inline]

Constructor uses initial state, so that the history can not be empty. This initial state is used for reset. Definition at line 151 of file history.h.

---

Member Function Documentation

template<class Position, class Velocity> virtual void animal::HistoryS< Position, Velocity >::read (  std::istream &  in  )  [inline, virtual]

Read the whole history from the given input stream. No comments are allowed. Implements animal::History< Position, Velocity >. Definition at line 164 of file history.h. References animal::History< Position, Velocity >::push_back(), animal::History< Position, Velocity >::reset(), and animal::History< Position, Velocity >::toggleRecord().

template<class Position, class Velocity> virtual void animal::HistoryS< Position, Velocity >::write (  std::ostream &  out  )  const [inline, virtual]

Write the whole history to the given output stream. Implements animal::History< Position, Velocity >. Definition at line 156 of file history.h.

---

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

• history.h

---