Parses and manages a named set of indeces. More...

#include <TextIndex.h>

Inheritance diagram for TextIndex:

Public Member Functions
	TextIndex (const std::string &named_range)
	Construct from string of the form 'name=[range]'.
void	set_container (TextInterface::Parser *)
	Set the interface to the container to which the named index applies.
void	set_size_name (const std::string &name)
	Set the name of the index dimension size in the container interface.
unsigned	size () const
	Get the number of indeces.
std::string	get_index (unsigned i)
	Get the index command for the specified index.
std::string	get_current_index ()
	Get the index command for the current index.
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 Attributes
Reference::To< TextInterface::Parser, false >	container
	The text interface to the container.
std::string	name
	The name of the index.
std::string	size_name
	The name of the index dimension in the container.
std::string	range
	The range of the index set.
std::vector< unsigned >	indeces
	The indeces.

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.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
	Add the address of a reference to this object.
void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object.

Detailed Description

Parses and manages a named set of indeces.

Member Function Documentation

void TextIndex::set_container ( TextInterface::Parser * parser )

Set the interface to the container to which the named index applies.

Set the interface from which the maximum index will be determined.

void TextIndex::set_size_name ( const std::string & name )

Set the name of the index dimension size in the container interface.

\default "n" + name

References name, and size_name.

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