Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

commandl::string_arg Class Reference

An argument class that acts like a string. More...

#include <string_arg.hpp>

Inheritance diagram for commandl::string_arg:

commandl::argument List of all members.

Public Methods

 string_arg (std::vector< std::string >, std::string="", std::string="", bool=false, bool=false)
 string_arg (std::string, std::string="", std::string="", bool=false, bool=false)
void operator() (const std::string &, const std::string &, const unsigned long)
 This operator is called when there is no value to pass in. More...

void operator() (const std::string &, const std::string &, const std::string &, const std::string &, const unsigned long)
 Used when there is a single string to be passed as the value. More...

void operator() (const std::vector< std::string > &, const std::string &, const std::string &, const std::string &, const unsigned long)
 Can be used to pass a value contained in a vector. More...

string_arg & operator= (const std::string &)
 Assignment operator to make a string_arg act like a string. More...

string_arg & operator= (const char *)
string_arg & operator= (const char)

Detailed Description

An argument class that acts like a string.


Constructor & Destructor Documentation

commandl::string_arg::string_arg std::vector< std::string >   ,
std::string    = "",
std::string    = "",
bool    = false,
bool    = false
 

commandl::string_arg::string_arg std::string   ,
std::string    = "",
std::string    = "",
bool    = false,
bool    = false
 


Member Function Documentation

void commandl::string_arg::operator() const std::vector< std::string > &    values,
const std::string &    prefix,
const std::string &    key,
const std::string &    assign,
const unsigned    long
[virtual]
 

Can be used to pass a value contained in a vector.

It is important to note that string_arg can take only a single string as it's value. If the vector passed in has more than a single element, this operator will throw.

Implements commandl::argument.

void commandl::string_arg::operator() const std::string &    value,
const std::string &    prefix,
const std::string &    key,
const std::string &    assign,
const unsigned    long
[virtual]
 

Used when there is a single string to be passed as the value.

This operator should be used to pass a value in that will be the string that this class represents.

Implements commandl::argument.

void commandl::string_arg::operator() const std::string &    prefix,
const std::string &    key,
const unsigned    long
[virtual]
 

This operator is called when there is no value to pass in.

This operator should only be called when there is no corresponding value to be set. If values_size() returns anything other than zero, this version of the operator will throw.

Implements commandl::argument.

commandl::string_arg & commandl::string_arg::operator= const    char
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

commandl::string_arg & commandl::string_arg::operator= const char *    char_pointer
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

commandl::string_arg & commandl::string_arg::operator= const std::string &    the_string
 

Assignment operator to make a string_arg act like a string.


The documentation for this class was generated from the following files:
Generated on Sat Apr 5 21:17:28 2003 for commandl Library by doxygen1.2.15