CrystalSpace

Public API Reference

Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

csNodeIterator Class Reference

A node iterator. More...

#include <cstool/mapnode.h>

List of all members.

Public Member Functions

 csNodeIterator (iSector *pSector, const char *classname=0)
 The constructor.
 ~csNodeIterator ()
 The destructor as usual.
void Reset (iSector *pSector, const char *classname=0)
 Reuse the iterator for an other search.
iMapNodeNext ()
 Move forward.
bool HasNext () const
 Check if there are other nodes.

Protected Member Functions

void SkipWrongClassname ()
 Skip all nodes with wrong classname.
void NextNode ()
 Step to the next node in the sector, ignoring its classname.


Detailed Description

A node iterator.

Definition at line 61 of file mapnode.h.


Constructor & Destructor Documentation

csNodeIterator::csNodeIterator iSector pSector,
const char *  classname = 0
 

The constructor.

Theorectially, we could handle any iObject, but that doesn't make sense for the current implementation, so we restrict it to iSector to avoid some pitfalls.

If a classname is given, search is restricted to nodes, in which the key "classname" has the same value as the given classname. the classname string is _not_ duplicated, so the caller is responsible to take care, that the string is available while the Iterator is alive.

csNodeIterator::~csNodeIterator  ) 
 

The destructor as usual.


Member Function Documentation

bool csNodeIterator::HasNext  )  const
 

Check if there are other nodes.

iMapNode* csNodeIterator::Next  ) 
 

Move forward.

void csNodeIterator::NextNode  )  [protected]
 

Step to the next node in the sector, ignoring its classname.

void csNodeIterator::Reset iSector pSector,
const char *  classname = 0
 

Reuse the iterator for an other search.

void csNodeIterator::SkipWrongClassname  )  [protected]
 

Skip all nodes with wrong classname.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.3.9.1