Image Component Library (ICL)
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Private Attributes
icl::utils::StrTok Class Reference

String Tokenizer Utility class. More...

#include <StrTok.h>

List of all members.

Public Types

typedef std::vector
< std::string >
::reverse_iterator 
reverse_iterator
 reverse iterator type
typedef std::vector
< std::string >
::const_reverse_iterator 
const_reverse_iterator
 constant reverse iterator type
typedef std::vector
< std::string >::iterator 
iterator
 iterator type
typedef std::vector
< std::string >
::const_iterator 
const_iterator
 constant iterator type

Public Member Functions

 StrTok (const std::string &s, const std::string &delims, bool singleCharDelims=true, char escapeChar='\0')
 Constructor.
bool hasMoreTokens () const
 Returns whether more tokens are available using nextToken()
const std::string & nextToken ()
 Returns the next token (unsafe -> check with hasMoreTokens before)
unsigned int nTokens () const
 returns the internal token count
const std::vector< std::string > & allTokens () const
 returns a vector
void reset ()
 resets internal position indicator
iterator begin ()
 returns begin-iterator
const_iterator begin () const
 returns const begin-iterator
reverse_iterator rbegin ()
 returns reverse begin-iterator
const_reverse_iterator rbegin () const
 returns const reverse begin-iterator
iterator end ()
 returns end-iterator
const_iterator end () const
 returns const end-iterator
reverse_iterator rend ()
 returns reverse end-iterator
const_reverse_iterator rend () const
 returns const reverse end-iterator

Private Attributes

std::vector< std::string > m_oTokens
 internal data storage
unsigned int m_uiPos
 current position indicator

Detailed Description

String Tokenizer Utility class.


Member Typedef Documentation

typedef std::vector<std::string>::const_iterator icl::utils::StrTok::const_iterator

constant iterator type

constant reverse iterator type

typedef std::vector<std::string>::iterator icl::utils::StrTok::iterator

iterator type

typedef std::vector<std::string>::reverse_iterator icl::utils::StrTok::reverse_iterator

reverse iterator type


Constructor & Destructor Documentation

icl::utils::StrTok::StrTok ( const std::string &  s,
const std::string &  delims,
bool  singleCharDelims = true,
char  escapeChar = '\0' 
)

Constructor.

Parameters:
sstring to be tokenized
delimsdelimiter string: meaning depends on singleCharDelims
singleCharDelimsif this is true (default), each character of delims is treated a single possible delimiter. Otherwise, the delims string is used as a delimiter sequence
escapeCharif this char is not '\0', delimiter occurences are skipped, if this char is found directly before the delimiter. (Often the '\' char is used here)

Member Function Documentation

const std::vector<std::string>& icl::utils::StrTok::allTokens ( ) const

returns a vector

returns begin-iterator

returns const begin-iterator

returns end-iterator

returns const end-iterator

Returns whether more tokens are available using nextToken()

note: nextToken is not safe; it must be checked with hasMoreTokens

const std::string& icl::utils::StrTok::nextToken ( )

Returns the next token (unsafe -> check with hasMoreTokens before)

unsigned int icl::utils::StrTok::nTokens ( ) const

returns the internal token count

returns reverse begin-iterator

returns const reverse begin-iterator

returns reverse end-iterator

returns const reverse end-iterator

void icl::utils::StrTok::reset ( ) [inline]

resets internal position indicator


Member Data Documentation

std::vector<std::string> icl::utils::StrTok::m_oTokens [private]

internal data storage

unsigned int icl::utils::StrTok::m_uiPos [private]

current position indicator


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines