SourcePro® API Reference Guide

 
List of all members | Public Types | Public Member Functions | Related Functions
RWUEncodingNameStandardListIterator Class Reference

A C++ Standard Library-compatible random-access iterator for class RWUEncodingNameStandardList. More...

#include <rw/i18n/RWUEncodingNameStandardListIterator.h>

Public Types

typedef int32_t difference_type
 
typedef std::random_access_iterator_tag iterator_category
 
typedef value_typepointer
 
typedef value_type reference
 
typedef const char * value_type
 

Public Member Functions

 RWUEncodingNameStandardListIterator (void)
 
 RWUEncodingNameStandardListIterator (const RWUEncodingNameStandardListIterator &source)
 
 ~RWUEncodingNameStandardListIterator ()
 
bool operator!= (const RWUEncodingNameStandardListIterator &rhs) const
 
value_type operator* () const
 
RWUEncodingNameStandardListIteratoroperator++ ()
 
RWUEncodingNameStandardListIterator operator++ (int)
 
RWUEncodingNameStandardListIteratoroperator+= (difference_type offset)
 
difference_type operator- (const RWUEncodingNameStandardListIterator &rhs) const
 
RWUEncodingNameStandardListIteratoroperator-- ()
 
RWUEncodingNameStandardListIterator operator-- (int)
 
RWUEncodingNameStandardListIteratoroperator-= (difference_type offset)
 
bool operator< (const RWUEncodingNameStandardListIterator &rhs) const
 
bool operator<= (const RWUEncodingNameStandardListIterator &rhs) const
 
RWUEncodingNameStandardListIteratoroperator= (const RWUEncodingNameStandardListIterator &rhs)
 
bool operator== (const RWUEncodingNameStandardListIterator &rhs) const
 
bool operator> (const RWUEncodingNameStandardListIterator &rhs) const
 
bool operator>= (const RWUEncodingNameStandardListIterator &rhs) const
 
value_type operator[] (difference_type offset) const
 

Related Functions

(Note that these are not member functions.)

RWUEncodingNameStandardListIterator operator+ (RWUEncodingNameStandardListIterator::difference_type offset, const RWUEncodingNameStandardListIterator &rhs)
 
RWUEncodingNameStandardListIterator operator+ (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)
 
RWUEncodingNameStandardListIterator operator- (const RWUEncodingNameStandardListIterator &lhs, RWUEncodingNameStandardListIterator::difference_type offset)
 

Detailed Description

RWUEncodingNameStandardListIterator is a C++ Standard Library-compatible random-access iterator for class RWUEncodingNameStandardList. An instance of RWUEncodingNameStandardListIterator can be used to access the list of encoding name standards that are currently recognized by the Internationalization Module. The list cannot be changed at run time.

Example
#include <rw/i18n/RWUEncodingNameStandardList.h>
#include <iostream>
int
main()
{
// Iterate over the list of standards and write them
// to std::cout, obtaining iterators from the static
// RWUEncodingNameStandardListIterator begin() and end()
// methods.
++iter)
{
std::cout << *iter << std::endl;
}
// Iterate over the list of standards again, obtaining
// iterators from an RWUEncodingNameStandardList object.
for (iter = list.begin(); iter != list.end(); ++iter) {
std::cout << *iter << std::endl;
}
return 0;
}
See also
RWUEncodingNameStandardList

Member Typedef Documentation

Declares an alias for the type used to represent iterator offsets and differences.

typedef std::random_access_iterator_tag RWUEncodingNameStandardListIterator::iterator_category

Tags this class as a C++ Standard Library-compatible random-access iterator.

Declares an alias for the value pointer type.

Declares an alias for the value reference type.

Declares an alias for the value type returned by operator*().

Constructor & Destructor Documentation

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator ( void  )
inline

Default constructor. Creates an invalid iterator. Attempts to dereference an invalid iterator throw RWBoundsErr. Use RWUEncodingNameStandardList to obtain valid iterators.

RWUEncodingNameStandardListIterator::RWUEncodingNameStandardListIterator ( const RWUEncodingNameStandardListIterator source)
inline

Copy constructor.

RWUEncodingNameStandardListIterator::~RWUEncodingNameStandardListIterator ( )
inline

Destructor.

Member Function Documentation

bool RWUEncodingNameStandardListIterator::operator!= ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is not equal to the list position of rhs; otherwise, false.

RWUEncodingNameStandardListIterator::value_type RWUEncodingNameStandardListIterator::operator* ( ) const
inline

Returns a const char* to a null-terminated character string that contains the name of the encoding name standard located at the list position specified by self.

The storage for this string is owned by the library.

Exceptions
RWBoundsErrThrown if the iterator is invalid or positioned past the end of the list.
RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator++ ( )
inline

Repositions self to the next position in the encoding name standard list and returns a reference to self.

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator++ ( int  )
inline

Repositions self to the next position in the encoding name standard list and returns a copy of the previous value of self.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator+= ( difference_type  offset)
inline

Repositions self to a new position in the encoding name standard list by adding offset to the current iterator position, and returns a reference to self.

RWUEncodingNameStandardListIterator::difference_type RWUEncodingNameStandardListIterator::operator- ( const RWUEncodingNameStandardListIterator rhs) const
inline

Calculates the difference, or distance, between self and rhs.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator-- ( )
inline

Repositions self to the preceding position in the encoding name standard list and returns a reference to self.

RWUEncodingNameStandardListIterator RWUEncodingNameStandardListIterator::operator-- ( int  )
inline

Repositions self to the preceding position in the encoding name standard list and returns a copy of the previous value of self.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator-= ( difference_type  offset)
inline

Repositions self to a new position in the encoding name standard list by subtracting offset from the current iterator position, and returns a reference to self.

bool RWUEncodingNameStandardListIterator::operator< ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is less than the list position of rhs; otherwise, false.

bool RWUEncodingNameStandardListIterator::operator<= ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is less than or equal to the list position of rhs; otherwise; false.

RWUEncodingNameStandardListIterator & RWUEncodingNameStandardListIterator::operator= ( const RWUEncodingNameStandardListIterator rhs)
inline

Changes the state of self to match that of rhs.

bool RWUEncodingNameStandardListIterator::operator== ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is equal to the list position of rhs; otherwise, false.

bool RWUEncodingNameStandardListIterator::operator> ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is greater than the list position of rhs; otherwise, false.

bool RWUEncodingNameStandardListIterator::operator>= ( const RWUEncodingNameStandardListIterator rhs) const
inline

Returns true if the list position of self is greater than or equal to the list position of rhs; otherwise, false.

RWUEncodingNameStandardListIterator::value_type RWUEncodingNameStandardListIterator::operator[] ( difference_type  offset) const
inline

Returns a const char* to a null-terminated character string that contains the name of the encoding name standard located at the list position specified by the given offset from self.

Friends And Related Function Documentation

Returns a new iterator whose list position is calculated by adding offset to the position of rhs.

Returns a new iterator whose list position is calculated by adding offset to the position of lhs.

Returns a new iterator whose list position is calculated by subtracting offset from the position of lhs.

Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.