MSUpdateEachTimestep< ToUpdate > Class Template Reference

#include <MSUpdateEachTimestep.h>

---

Detailed Description

template<class ToUpdate>
class MSUpdateEachTimestep< ToUpdate >

Base class for objects that shall be updated in each simulation step.

Definition at line 43 of file MSUpdateEachTimestep.h.

Public Member Functions
	MSUpdateEachTimestep () throw ()
	Counstructor.
virtual bool	updateEachTimestep ()=0 throw ()
	The update method.
virtual	~MSUpdateEachTimestep () throw ()
	Destructor.

---

Constructor & Destructor Documentation

template<class ToUpdate>

MSUpdateEachTimestep< ToUpdate >::MSUpdateEachTimestep

(

)

throw () [inline]

Counstructor.

Definition at line 46 of file MSUpdateEachTimestep.h.

                                   {
        MSUpdateEachTimestepContainer< MSUpdateEachTimestep<
        ToUpdate > >::getInstance()->addItemToUpdate(this);
    }

template<class ToUpdate>

virtual MSUpdateEachTimestep< ToUpdate >::~MSUpdateEachTimestep

(

)

throw () [inline, virtual]

Destructor.

Definition at line 53 of file MSUpdateEachTimestep.h.

                                            {
        MSUpdateEachTimestepContainer< MSUpdateEachTimestep<
        ToUpdate > >::getInstance()->removeItemToUpdate(this);
    }

---

Member Function Documentation

template<class ToUpdate>

virtual bool MSUpdateEachTimestep< ToUpdate >::updateEachTimestep

(

)

throw () [pure virtual]

The update method.

Derived objects will be called in each time step using this method

Returns:

discarded (unused)

Implemented in GLObjectValuePassConnector< T >, and GLObjectValuePassConnector< std::pair< int, MSPhaseDefinition > >.

---

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

• MSUpdateEachTimestep.h