TextLoop Class Reference

Loop through ranges of indeces ascertained by a TextInterface. More...

#include <TextLoop.h>

Inheritance diagram for TextLoop:

Public Member Functions
	TextLoop ()
	Default constructor.

void	set_container (TextInterface::Parser *)
	Set the interface of the container to which the named indeces apply.

void	add_index (TextIndex *)
	Add an index over which to loop.

void	loop ()
	Execute the job for each index in the stack.

std::string	get_index_state () const
	Retrieve the index state.

Public Member Functions inherited from Reference::Able
	Able ()
	Default constructor.

	Able (const Able &)
	Copy constructor.

Able &	operator= (const Able &)
	Assignment operator.

virtual	~Able ()
	Destructor.

unsigned	get_reference_count () const
	Returns the number of references there are to this.

Public Member Functions inherited from Reference::HeapTracked
	HeapTracked ()
	Default constructor.

	HeapTracked (const HeapTracked &)
	Copy constructor.

HeapTracked &	operator= (const HeapTracked &)
	Assignment operator.

virtual	~HeapTracked ()
	Destructor.

bool	__is_on_heap () const
	Return true if this instance is found in heap addresses.

Protected Types
typedef std::stack< Reference::To< TextIndex > >	Stack
	The indeces over which to loop.

Protected Member Functions
void	loop (Stack &indeces)
	Worker function called recursively down stack.

Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
	Add the address of a reference to this object. More...

void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object. More...

Protected Attributes
Stack	indeces

Reference::To< TextInterface::Parser >	container
	The container interface to configure on each loop.

std::string	index_state
	Current state of each index.

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
	Returns the current number instances in existence.

Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
	Records the addresses of new instances allocated on the heap.

static void	operator delete (void location, void ptr)
	Placement delete overload to match the placement new overload.

static void	operator delete (void *location)
	Regular delete overload.

static size_t	get_heap_queue_size ()
	Return the number of heap addresses awaiting processing.

Detailed Description

Loop through ranges of indeces ascertained by a TextInterface.

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