#include <iterator.h>

Public Types
typedef Tf_IteratorInterface < T, Reverse >	IterInterface

typedef IterInterface::IteratorType	Iterator

typedef std::iterator_traits < Iterator >::reference	Reference

Public Member Functions
	TfIterator ()
	Default constructor. This iterator is uninitialized. More...

	TfIterator (T &container)

	TfIterator (T &&container)
	Allow rvalues only if the container type T should be copied by TfIterator. More...

	TfIterator (Iterator const &begin, Iterator const &end)

bool	operator! () const

bool	operator== (const TfIterator &iterator) const

bool	operator!= (const TfIterator &iterator) const

TfIterator &	operator++ ()

TfIterator	operator++ (int)

Reference	operator* ()

Reference	operator* () const

Iterator &	operator-> ()

	operator bool () const

	operator Iterator () const

const Iterator &	base () const

TfIterator	GetNext () const

Detailed Description

template<class T, bool Reverse = false>
class TfIterator< T, Reverse >

A simple iterator adapter for STL containers.

TfIterator iterates over the elements in an STL container, according to the semantics of the simple iterator pattern. The following examples compare the TfIterator to STL, highlighting the brevity of the TfIterator interface.

std::vector<int> vector;
std::set<int> set;
// TfIterator 'while' loop
TfIterator< std::vector<int> > i(vector);
while (i) {
    int x = *i++;
}
// STL 'while' loop
std::vector<int>::iterator i = vector.begin();
while (i != vector.end()) {
    int x = *i++;
}
// TfIterator 'for' loop
std::set<int> set;
for (TfIterator< const std::set<int> > j = set; j; ++j) {
    int x = *j;
}
// STL 'for' loop
std::set<int> set;
for (std::set<int>::iterator j = set.begin(); j != set.end(); ++j) {
    int x = *j;
}

Note that using the TF_FOR_ALL() macro, even more brevity is possible. For example, to print out all items of a set<int> s, we could write

TF_FOR_ALL(i, s)

printf("%d\n", *i);

Typically, a TfIterator is used to traverse all of the elements in an STL container. For ordered sets, other uses include iterating over a subset of the elements in the container, and using a TfIterator as a sentinel.

// Iterate over subset
TfIterator< std::vector<int> > start, finish;
TfIterator< std::vector<int> > iterator(start, finish);
// TfIterator sentinel
TfIterator< std::vector<int> > sentinel(finish, finish);
while (iterator != sentinel) {
    int x = *iterator++;
}

The Simple Iterator Pattern

The simple iterator pattern generalizes pointer semantics to traverse a set of elements, much like STL iterators. However, the simple iterator pattern subscribes to a simpler subset of pointer operations: pointer assignment (operator=), auto-increment (operator++), dereferencing (operator*), redirection (operator->), and null pointer comparison (operator! and operator bool). The simpler interface improves code legibility for the typical set traversals for which iterators are most commonly used. It is particularly useful for specifying iterators over sets of elements that are maintained by a user object, since the interface calls for only one GetIterator() entry point rather than dual begin() and end() calls. This is especially desirable when the object owns many different sets.

// The simple iterator pattern.
class Iterator {
    Iterator();                                     // default c'tor
    Iterator(const Iterator&);                      // copy c'tor
    Iterator& operator=(const Iterator &);          // assignment
    Iterator& operator++();                         // pre-increment
    Iterator operator++(int);                       // post-increment
    reference operator *();                         // dereference
    pointer operator->();                           // redirection
    bool operator==(const Iterator &) const;        // equality
    bool operator!=(const Iterator &) const;        // inequality
    bool operator!() const                          // is exhausted
    operator bool() const;                          // is not exhausted
};

Parameters

T	container type

Definition at line 159 of file iterator.h.

Member Typedef Documentation

template<class T, bool Reverse = false>

typedef IterInterface::IteratorType TfIterator< T, Reverse >::Iterator

Definition at line 176 of file iterator.h.

template<class T, bool Reverse = false>

typedef Tf_IteratorInterface<T, Reverse> TfIterator< T, Reverse >::IterInterface

Definition at line 175 of file iterator.h.

template<class T, bool Reverse = false>

typedef std::iterator_traits<Iterator>::reference TfIterator< T, Reverse >::Reference

Definition at line 178 of file iterator.h.

Constructor & Destructor Documentation

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::TfIterator ( )

inline

Default constructor. This iterator is uninitialized.

Definition at line 181 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::TfIterator ( T & container )

inline

Constructs an iterator to traverse each element of the specified STL container object.

Parameters

container container object

Definition at line 186 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::TfIterator ( T && container )

inline

Allow rvalues only if the container type T should be copied by TfIterator.

Definition at line 189 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::TfIterator	(	Iterator const &	begin,
		Iterator const &	end
	)

inline

Constructs an iterator to traverse a subset of the elements in a container. This iterator is exhausted when it reaches the end iterator.

Parameters

begin	iterator at the beginning of the sequence
end	iterator at the end of the sequence

Definition at line 203 of file iterator.h.

Member Function Documentation

template<class T, bool Reverse = false>

const Iterator& TfIterator< T, Reverse >::base ( ) const

inline

Returns an STL iterator that has the same position as this iterator.

Returns: STL iterator at the same position as this iterator

Definition at line 290 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator TfIterator< T, Reverse >::GetNext ( ) const

inline

Returns an iterator that is positioned at the next element in the sequence.

Returns: iterator at next element in the sequence

Definition at line 297 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::operator bool ( ) const

inlineexplicit

Explicit bool conversion operator. The Iterator object converts to true if it has not been exhausted.

Definition at line 276 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator< T, Reverse >::operator Iterator ( ) const

inline

Returns an STL iterator that has the same position as this iterator.

Returns: STL iterator at the same position as this iterator

Definition at line 283 of file iterator.h.

template<class T, bool Reverse = false>

bool TfIterator< T, Reverse >::operator! ( void ) const

inline

Returns true if this iterator is exhausted.

Returns: true if this iterator is exhausted

Definition at line 210 of file iterator.h.

template<class T, bool Reverse = false>

bool TfIterator< T, Reverse >::operator!= ( const TfIterator< T, Reverse > & iterator ) const

inline

Returns false if (*this == iterator) returns true, returns true otherwise.

Definition at line 224 of file iterator.h.

template<class T, bool Reverse = false>

Reference TfIterator< T, Reverse >::operator* ( )

inline

Returns the element referenced by this iterator.

Returns: element

Definition at line 252 of file iterator.h.

template<class T, bool Reverse = false>

Reference TfIterator< T, Reverse >::operator* ( ) const

inline

Returns the element referenced by this iterator.

Returns: element

Definition at line 260 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator& TfIterator< T, Reverse >::operator++ ( )

inline

Pre-increment operator. Advances this iterator to the next element in the sequence.

Returns: this iterator

Definition at line 231 of file iterator.h.

template<class T, bool Reverse = false>

TfIterator TfIterator< T, Reverse >::operator++ ( int )

inline

Post-increment operator. Advances this iterator to the next element in the sequence, and returns a copy of this iterator prior to the increment.

Returns: copy of this iterator prior to increment

Definition at line 244 of file iterator.h.

template<class T, bool Reverse = false>

Iterator& TfIterator< T, Reverse >::operator-> ( )

inline

Returns a pointer to the element referenced by this iterator.

Returns: pointer to element

Definition at line 268 of file iterator.h.

template<class T, bool Reverse = false>

bool TfIterator< T, Reverse >::operator== ( const TfIterator< T, Reverse > & iterator ) const

inline

Returns true if this Iterator.has the same position in the sequence as the specified iterator. The end of the sequence need not be the same.

Parameters

iterator iterator to compare

Returns: true if this Iterator.has the same position as iterator

Definition at line 218 of file iterator.h.

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

pxr/base/tf/iterator.h

Public Types

Public Member Functions

Detailed Description

template<class T, bool Reverse = false> class TfIterator< T, Reverse >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class T, bool Reverse = false>
class TfIterator< T, Reverse >