Core::TextFileIterator Class Reference

The iterator type used to read lines of text from a file. More...

#include <TextFileIterator.hpp>

List of all members.

Public Member Functions
	TextFileIterator ()
	Constructor for the End iterator.
	TextFileIterator (const tstring &filename)
	Constructor for the Begin iterator.
	~TextFileIterator ()
	Destructor.
const tstring &	operator* () const
	Dereference operator.
const tstring *	operator-> () const
	Pointer-to-member operator.
void	operator++ ()
	Advance the iterator.
bool	equals (const TextFileIterator &rhs) const
	Compare to another iterator for equivalence.
Private Types
typedef UniquePtr< tifstream >	StreamPtr
	The underlying input file stream.
typedef UniquePtr< tstring >	StringPtr
	The current value;.
Private Member Functions
void	increment ()
	Move the iterator forward.
void	reset ()
	Move the iterator to the End.
Private Attributes
StreamPtr	m_stream
	The underlying file stream;.
StringPtr	m_value
	The current iterator value.

---

Detailed Description

The iterator type used to read lines of text from a file.

---

Member Typedef Documentation

typedef UniquePtr<tifstream> Core::TextFileIterator::StreamPtr [private]

The underlying input file stream.

typedef UniquePtr<tstring> Core::TextFileIterator::StringPtr [private]

The current value;.

---

Constructor & Destructor Documentation

Core::TextFileIterator::TextFileIterator

(

)

Constructor for the End iterator.

Core::TextFileIterator::TextFileIterator

(

const tstring &

filename

)

Constructor for the Begin iterator.

Core::TextFileIterator::~TextFileIterator

(

)

Destructor.

---

Member Function Documentation

const tstring & Core::TextFileIterator::operator*

(

)

const

Dereference operator.

const tstring * Core::TextFileIterator::operator->

(

)

const

Pointer-to-member operator.

void Core::TextFileIterator::operator++

(

)

[inline]

Advance the iterator.

bool Core::TextFileIterator::equals

(

const TextFileIterator &

rhs

)

const

Compare to another iterator for equivalence.

void Core::TextFileIterator::increment

(

)

[private]

Move the iterator forward.

void Core::TextFileIterator::reset

(

)

[private]

Move the iterator to the End.

---

Member Data Documentation

StreamPtr Core::TextFileIterator::m_stream [private]

The underlying file stream;.

StringPtr Core::TextFileIterator::m_value [private]

The current iterator value.

---

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

• TextFileIterator.hpp
• TextFileIterator.cpp