MSUpdateEachTimestepContainer< UpdateEachTimestep > Class Template Reference

#include <MSUpdateEachTimestepContainer.h>

---

Detailed Description

template<class UpdateEachTimestep>
class MSUpdateEachTimestepContainer< UpdateEachTimestep >

Container of typed objects that shall be updated in each simulation step.

Definition at line 44 of file MSUpdateEachTimestepContainer.h.

Public Member Functions
void	addItemToUpdate (UpdateEachTimestep *item) throw ()
	Adds an item that shall be updated in each time step [in] item The item to add.
void	clear () throw ()
	Clears the container.
void	removeItemToUpdate (UpdateEachTimestep *item) throw ()
	Removes an item [in] item The item to remove.
void	updateAll ()
	Updates all items.
	~MSUpdateEachTimestepContainer () throw ()
	Destructor.
Static Public Member Functions
static MSUpdateEachTimestepContainer *	getInstance () throw ()
	Singleton instance retriever.
Private Member Functions
	MSUpdateEachTimestepContainer ()
	Constructor.
Private Attributes
std::vector< UpdateEachTimestep * >	myContainer
	The container of items that shall be updated.
Static Private Attributes
static MSUpdateEachTimestepContainer *	myInstance = 0
	The singleton instance.

---

Constructor & Destructor Documentation

template<class UpdateEachTimestep>

MSUpdateEachTimestepContainer< UpdateEachTimestep >::~MSUpdateEachTimestepContainer

(

)

throw () [inline]

Destructor.

Definition at line 89 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer, and MSUpdateEachTimestepContainer< UpdateEachTimestep >::myInstance.

                                             {
        myContainer.clear();
        myInstance = 0;
    }

template<class UpdateEachTimestep>

MSUpdateEachTimestepContainer< UpdateEachTimestep >::MSUpdateEachTimestepContainer

(

)

[inline, private]

Constructor.

Definition at line 109 of file MSUpdateEachTimestepContainer.h.

Referenced by MSUpdateEachTimestepContainer< UpdateEachTimestep >::getInstance().

            : myContainer() {}

---

Member Function Documentation

template<class UpdateEachTimestep>

void MSUpdateEachTimestepContainer< UpdateEachTimestep >::addItemToUpdate

(

UpdateEachTimestep *

item

)

throw () [inline]

Adds an item that shall be updated in each time step [in] item The item to add.

Definition at line 60 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer.

                                                           {
        myContainer.push_back(item);
    }

template<class UpdateEachTimestep>

void MSUpdateEachTimestepContainer< UpdateEachTimestep >::clear

(

)

throw () [inline]

Clears the container.

All items will be destructed

Definition at line 99 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer.

                         {
        for (typename std::vector< UpdateEachTimestep* >::iterator i=myContainer.begin(); i!=myContainer.end(); ++i) {
            delete(*i);
        }
        myContainer.clear();
    }

template<class UpdateEachTimestep>

static MSUpdateEachTimestepContainer* MSUpdateEachTimestepContainer< UpdateEachTimestep >::getInstance

(

void

)

throw () [inline, static]

Singleton instance retriever.

Returns:

The instance of this singleton

Definition at line 49 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::MSUpdateEachTimestepContainer(), and MSUpdateEachTimestepContainer< UpdateEachTimestep >::myInstance.

                                                                {
        if (myInstance == 0) {
            myInstance = new MSUpdateEachTimestepContainer();
        }
        return myInstance;
    }

template<class UpdateEachTimestep>

void MSUpdateEachTimestepContainer< UpdateEachTimestep >::removeItemToUpdate

(

UpdateEachTimestep *

item

)

throw () [inline]

Removes an item [in] item The item to remove.

Definition at line 68 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer.

                                                              {
        typename std::vector< UpdateEachTimestep* >::iterator i =
            std::find(myContainer.begin(), myContainer.end(), item);
        if (i!=myContainer.end()) {
            myContainer.erase(i);
        }
    }

template<class UpdateEachTimestep>

void MSUpdateEachTimestepContainer< UpdateEachTimestep >::updateAll

(

)

[inline]

Updates all items.

Calls updateEachTimestep on all stored items

See also:

MSUpdateEachTimestep::updateEachTimestep

Definition at line 82 of file MSUpdateEachTimestepContainer.h.

References MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer.

                     {
        std::for_each(myContainer.begin(), myContainer.end(),
                      std::mem_fun(&UpdateEachTimestep::updateEachTimestep));
    }

---

Field Documentation

template<class UpdateEachTimestep>

std::vector< UpdateEachTimestep* > MSUpdateEachTimestepContainer< UpdateEachTimestep >::myContainer [private]

The container of items that shall be updated.

Definition at line 114 of file MSUpdateEachTimestepContainer.h.

Referenced by MSUpdateEachTimestepContainer< UpdateEachTimestep >::addItemToUpdate(), MSUpdateEachTimestepContainer< UpdateEachTimestep >::clear(), MSUpdateEachTimestepContainer< UpdateEachTimestep >::removeItemToUpdate(), MSUpdateEachTimestepContainer< UpdateEachTimestep >::updateAll(), and MSUpdateEachTimestepContainer< UpdateEachTimestep >::~MSUpdateEachTimestepContainer().

template<class UpdateEachTimestep>

MSUpdateEachTimestepContainer< UpdateEachTimestep > * MSUpdateEachTimestepContainer< UpdateEachTimestep >::myInstance = 0 [inline, static, private]

The singleton instance.

Definition at line 117 of file MSUpdateEachTimestepContainer.h.

Referenced by MSUpdateEachTimestepContainer< UpdateEachTimestep >::getInstance(), and MSUpdateEachTimestepContainer< UpdateEachTimestep >::~MSUpdateEachTimestepContainer().

---

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

• MSUpdateEachTimestepContainer.h