ACE_String_Base_Iterator< ACE_CHAR_T > Class Template Reference

Iterator class for the ACE_String_Base class. More...

#include <String_Base.h>

Public Types
typedef std::bidirectional_iterator_tag	iterator_category
typedef ACE_CHAR_T	value_type
typedef ACE_CHAR_T &	reference
typedef ACE_CHAR_T *	pointer
typedef ptrdiff_t	difference_type

Public Member Functions
	ACE_String_Base_Iterator (ACE_String_Base< ACE_CHAR_T > &str, int end=0)
	ACE_String_Base_Iterator (const ACE_String_Base_Iterator< ACE_CHAR_T > &iter)
	~ACE_String_Base_Iterator (void)
	Destructor. More...
int	done (void) const
int	next (ACE_CHAR_T *&ch) const
int	advance (void)
const ACE_String_Base_Iterator< ACE_CHAR_T > &	operator= (const ACE_String_Base_Iterator< ACE_CHAR_T > &iter)
ACE_CHAR_T &	operator* (void)
ACE_String_Base_Iterator< ACE_CHAR_T > &	operator++ (void)
ACE_String_Base_Iterator< ACE_CHAR_T >	operator++ (int)
ACE_String_Base_Iterator< ACE_CHAR_T > &	operator-- (void)
ACE_String_Base_Iterator< ACE_CHAR_T >	operator-- (int)
bool	operator== (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const
bool	operator!= (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const
bool	operator< (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const
bool	operator> (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const
bool	operator<= (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const
bool	operator>= (const ACE_String_Base_Iterator< ACE_CHAR_T > &rhs) const

Private Attributes
ACE_String_Base< ACE_CHAR_T > *	str_
	Target string to iterate over. More...
size_t	index_
	Current location in the string. More...

Detailed Description

template<class ACE_CHAR_T>
class ACE_String_Base_Iterator< ACE_CHAR_T >

Iterator class for the ACE_String_Base class.

This class is an implementation of an iterator that allows client applications it iterator over the contents of a string. Currently, now this iterator fall under the std::bidirectional_iterator_tag category. Future versions of the class will support the operations of std::random_access_iterator_tag.

Member Typedef Documentation

template<class ACE_CHAR_T >

typedef ptrdiff_t ACE_String_Base_Iterator< ACE_CHAR_T >::difference_type

template<class ACE_CHAR_T >

typedef std::bidirectional_iterator_tag ACE_String_Base_Iterator< ACE_CHAR_T >::iterator_category

template<class ACE_CHAR_T >

typedef ACE_CHAR_T* ACE_String_Base_Iterator< ACE_CHAR_T >::pointer

template<class ACE_CHAR_T >

typedef ACE_CHAR_T& ACE_String_Base_Iterator< ACE_CHAR_T >::reference

template<class ACE_CHAR_T >

typedef ACE_CHAR_T ACE_String_Base_Iterator< ACE_CHAR_T >::value_type

Constructor & Destructor Documentation

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T >::ACE_String_Base_Iterator ( ACE_String_Base< ACE_CHAR_T > &  str, int  end = 0  )

inline

Initializing constructor

Parameters

[in]

str

Target string for iterator.

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T >::ACE_String_Base_Iterator ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  iter )

inline

Copy constructor

Parameters

[in]

iter

Iterator to copy.

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T >::~ACE_String_Base_Iterator ( void  )

inline

Destructor.

Member Function Documentation

template<class ACE_CHAR_T >

int ACE_String_Base_Iterator< ACE_CHAR_T >::advance

(

void

)

Move to the next character in the string.

Return values

0	All characters have been seen.
1	Items still remain to be seen.

template<class ACE_CHAR_T >

int ACE_String_Base_Iterator< ACE_CHAR_T >::done ( void  ) const

inline

Test if the iterator has seen all characters.

Return values

0	Characters still remain.
1	All characters have been seen.

template<class ACE_CHAR_T >

int ACE_String_Base_Iterator< ACE_CHAR_T >::next

(

ACE_CHAR_T *&

ch

)

const

Get the current character.

Parameters

[out]

ch

The current character.

Return values

0	All characters have been seen.
1	Items still remain to be seen.

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator!= ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

Ineqaulity comparison operator

Parameters

[in]

rhs

Right-hand side of operator.

template<class ACE_CHAR_T >

ACE_CHAR_T & ACE_String_Base_Iterator< ACE_CHAR_T >::operator* ( void  )

inline

Dereference operator

Returns

Reference to current character seen by iterator.

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T > & ACE_String_Base_Iterator< ACE_CHAR_T >::operator++ ( void  )

inline

Prefix operator

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T > ACE_String_Base_Iterator< ACE_CHAR_T >::operator++ ( int  )

inline

Postfix operator

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T > & ACE_String_Base_Iterator< ACE_CHAR_T >::operator-- ( void  )

inline

Prefix operator

template<class ACE_CHAR_T >

ACE_String_Base_Iterator< ACE_CHAR_T > ACE_String_Base_Iterator< ACE_CHAR_T >::operator-- ( int  )

inline

Postfix operator

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator< ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator<= ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

template<class ACE_CHAR_T >

const ACE_String_Base_Iterator< ACE_CHAR_T > & ACE_String_Base_Iterator< ACE_CHAR_T >::operator=

(

const ACE_String_Base_Iterator< ACE_CHAR_T > &

iter

)

Assignment operator

Parameters

[in]

iter

Right-hand side of operator.

Returns

Reference to self.

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator== ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

Eqaulity comparison operator

Parameters

[in]

rhs

Right-hand side of operator.

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator> ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

template<class ACE_CHAR_T >

bool ACE_String_Base_Iterator< ACE_CHAR_T >::operator>= ( const ACE_String_Base_Iterator< ACE_CHAR_T > &  rhs ) const

inline

Member Data Documentation

template<class ACE_CHAR_T >

size_t ACE_String_Base_Iterator< ACE_CHAR_T >::index_

private

Current location in the string.

template<class ACE_CHAR_T >

ACE_String_Base<ACE_CHAR_T>* ACE_String_Base_Iterator< ACE_CHAR_T >::str_

private

Target string to iterate over.

---

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

• String_Base.h
• String_Base.cpp
• String_Base.inl