Facilita::ExtractionCursor Class Reference

This class maintains information over a sequence of textual searches. More...

Public Methods
	ExtractionCursor (bool extractFromEnd=false)
	Default constructor. More...
virtual	~ExtractionCursor ()
void	reset ()
	Reset this object for re-use. More...
Public Properties
int	getIndex ()
	Get the current position of the search. More...
bool	succeeded ()
	Has the last search succeeded? More...
string	getErrorMessage () const
	Get any error message. More...

Detailed Description

This class maintains information over a sequence of textual searches.

Each search takes the instance as a parameter and maintains the current position and the success or failure of the last search.

Constructors

Facilita::ExtractionCursor::ExtractionCursor

(

bool

extractFromEnd = false

)

Default constructor.

virtual Facilita::ExtractionCursor::~ExtractionCursor ( )

virtual

Methods

string Facilita::ExtractionCursor::getErrorMessage

(

)

const

Get any error message.

Returns

The message.

int Facilita::ExtractionCursor::getIndex

(

)

Get the current position of the search.

Returns

The current position of the search.

void Facilita::ExtractionCursor::reset

(

)

Reset this object for re-use.

bool Facilita::ExtractionCursor::succeeded

(

)

Has the last search succeeded?

Returns

True if the lastsearch succeeeded false otherwise.

---

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

• ExtractionCursor.h