HOPS
HOPS class reference
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
hops::MHO_Tokenizer Class Reference

Class MHO_Tokenizer. More...

#include <MHO_Tokenizer.hh>

Public Member Functions

 MHO_Tokenizer ()
 
 ~MHO_Tokenizer ()
 
void GetTokens (std::vector< std::string > *tokens)
 
void SetDelimiter (const std::string &aDelim)
 
void SetIncludeEmptyTokensFalse ()
 
void SetIncludeEmptyTokensTrue ()
 
void SetPreserveQuotesFalse ()
 
void SetPreserveQuotesTrue ()
 
void SetRemoveLeadingTrailingWhitespaceFalse ()
 Setter for remove leading trailing whitespace false. More...
 
void SetRemoveLeadingTrailingWhitespaceTrue ()
 Setter for remove leading trailing whitespace true. More...
 
void SetString (const std::string *aString)
 
void SetUseMulticharacterDelimiterFalse ()
 
void SetUseMulticharacterDelimiterTrue ()
 

Static Public Member Functions

static std::string TrimLeadingAndTrailingWhitespace (const std::string &value)
 

Protected Member Functions

std::size_t IndexQuoteInstances (const std::string *aString, std::vector< std::pair< std::size_t, std::size_t > > *quotes)
 Finds and indexes quote instances in a given string. More...
 
void MultiCharTokenize (std::vector< std::string > *tokens)
 
void SingleCharTokenize (std::vector< std::string > *tokens)
 

Protected Attributes

const std::string * fCurrentString
 
std::string fDelim
 
bool fIncludeEmptyTokens
 
bool fMultiCharDelimiter
 
bool fPreserveQuotes
 
std::vector< std::pair< std::size_t, std::size_t > > fQuotePairIndexes
 
bool fRemoveLeadingTrailingWhitespace
 
const std::string * fString
 

Detailed Description

Class MHO_Tokenizer.

Date
Mon May 11 15:51:26 2020 -0400
Author
J. Barret - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du A configurable class reponsible for parsing a string on a given delimiter (default delimiter) is a space

Constructor & Destructor Documentation

◆ MHO_Tokenizer()

hops::MHO_Tokenizer::MHO_Tokenizer ( )

◆ ~MHO_Tokenizer()

hops::MHO_Tokenizer::~MHO_Tokenizer ( )

Member Function Documentation

◆ GetTokens()

void hops::MHO_Tokenizer::GetTokens ( std::vector< std::string > *  tokens)
  • Parse the string using the tokens
    Parameters
    tokenspointer to a vector of strings
    Returns
    None

◆ IndexQuoteInstances()

std::size_t hops::MHO_Tokenizer::IndexQuoteInstances ( const std::string *  aString,
std::vector< std::pair< std::size_t, std::size_t > > *  quotes 
)
protected

Finds and indexes quote instances in a given string.

Parameters
aStringInput string to search for quotes.
quotes(std::vector< std::pair< std::size_t, std::size_t ) *
Returns
Number of indexed quote pairs found.

◆ MultiCharTokenize()

void hops::MHO_Tokenizer::MultiCharTokenize ( std::vector< std::string > *  tokens)
protected

◆ SetDelimiter()

void hops::MHO_Tokenizer::SetDelimiter ( const std::string &  aDelim)
  • Set the delimiter to be used to parse the string in SetString
    Parameters
    aDelimstring a string to be used as a delimiter
    Returns
    None

◆ SetIncludeEmptyTokensFalse()

void hops::MHO_Tokenizer::SetIncludeEmptyTokensFalse ( )
  • Do not include empty tokens and set fincludeEmptyTokens to false
    Parameters
    None
    Returns
    None

◆ SetIncludeEmptyTokensTrue()

void hops::MHO_Tokenizer::SetIncludeEmptyTokensTrue ( )
  • Include empty tokens set fIncludeEmptyTokens to true for situations where two delimiters surround a substring which would result in an empty string
    Parameters
    None
    Returns
    None

◆ SetPreserveQuotesFalse()

void hops::MHO_Tokenizer::SetPreserveQuotesFalse ( )

◆ SetPreserveQuotesTrue()

void hops::MHO_Tokenizer::SetPreserveQuotesTrue ( )

◆ SetRemoveLeadingTrailingWhitespaceFalse()

void hops::MHO_Tokenizer::SetRemoveLeadingTrailingWhitespaceFalse ( )

Setter for remove leading trailing whitespace false.

◆ SetRemoveLeadingTrailingWhitespaceTrue()

void hops::MHO_Tokenizer::SetRemoveLeadingTrailingWhitespaceTrue ( )

Setter for remove leading trailing whitespace true.

◆ SetString()

void hops::MHO_Tokenizer::SetString ( const std::string *  aString)
  • Set the string to be parsed
    Parameters
    aStringstring
    Returns
    None

◆ SetUseMulticharacterDelimiterFalse()

void hops::MHO_Tokenizer::SetUseMulticharacterDelimiterFalse ( )

◆ SetUseMulticharacterDelimiterTrue()

void hops::MHO_Tokenizer::SetUseMulticharacterDelimiterTrue ( )

◆ SingleCharTokenize()

void hops::MHO_Tokenizer::SingleCharTokenize ( std::vector< std::string > *  tokens)
protected

◆ TrimLeadingAndTrailingWhitespace()

std::string hops::MHO_Tokenizer::TrimLeadingAndTrailingWhitespace ( const std::string &  value)
static

Member Data Documentation

◆ fCurrentString

const std::string* hops::MHO_Tokenizer::fCurrentString
protected

◆ fDelim

std::string hops::MHO_Tokenizer::fDelim
protected

◆ fIncludeEmptyTokens

bool hops::MHO_Tokenizer::fIncludeEmptyTokens
protected

◆ fMultiCharDelimiter

bool hops::MHO_Tokenizer::fMultiCharDelimiter
protected

◆ fPreserveQuotes

bool hops::MHO_Tokenizer::fPreserveQuotes
protected

◆ fQuotePairIndexes

std::vector< std::pair< std::size_t, std::size_t > > hops::MHO_Tokenizer::fQuotePairIndexes
protected

◆ fRemoveLeadingTrailingWhitespace

bool hops::MHO_Tokenizer::fRemoveLeadingTrailingWhitespace
protected

◆ fString

const std::string* hops::MHO_Tokenizer::fString
protected

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