GrainList Class Reference

#include <Grain.h>

Public Member Functions
	GrainList ()
	Default constructor.
void	pushGrain (Grain *grain)
	Pushes a grain to the tail of the list.
void	clearList ()
	Deletes all grains in the list.
GrainNode *	getHead ()
	Returns the head of the list.
void	updateAndReap ()
	Updates grains and deletes finished dynamic grains.

Detailed Description

Class for the management of a linked list of grains

Constructor & Destructor Documentation

GrainList()

GrainList::GrainList ( )

inline

Default constructor.

Member Function Documentation

clearList()

void GrainList::clearList

(

)

Deletes all grains in the list.

Deletes all grains in the GrainList.

getHead()

GrainNode * GrainList::getHead

(

)

Returns the head of the list.

Returns the head of the GrainList.

Returns

GrainNode*

pushGrain()

void GrainList::pushGrain

(

Grain *

grain

)

Pushes a grain to the tail of the list.

Pushes a grain to the tail of the GrainList.

Parameters

grain

the grain to be pushed

updateAndReap()

void GrainList::updateAndReap

(

)

Updates grains and deletes finished dynamic grains.

Runs update on all grains in the list. Deletes dynamic grains if they have finished their lifespan and are ready to be "reaped".

---

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

• src/Grain.h
• src/Grain.cpp