Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

ArArgumentBuilder Class Reference

This class is to build arguments for things that require argc and argv. More...

#include <ArArgumentBuilder.h>

List of all members.

Public Member Functions

void add (const char *str,...)
 Adds the given string, with varargs, seperates if there are spaces.
void addPlain (const char *str, int position=-1)
 Adds the given string, without varargs (wrapper for java).
void addStrings (int argc, char **argv, int position=-1)
 Adds the given string thats divided.
void addStrings (char **argv, int argc, int position=-1)
 Adds the given string thats divided.
 ArArgumentBuilder (const ArArgumentBuilder &builder)
 Copy Constructor.
 ArArgumentBuilder (size_t argvLen=512)
 Constructor.
void compressQuoted (bool stripQuotationMarks=false)
 Combines quoted arguments into one.
const char * getArg (size_t whichArg) const
 Gets a specific argument.
bool getArgBool (size_t whichArg) const
 Gets the value of an argument as a boolean (check with isArgBool).
size_t getArgc (void) const
 Gets the argc.
double getArgDouble (size_t whichArg) const
 Gets the value of an argument as a double (check with isArgDouble).
int getArgInt (size_t whichArg) const
 Gets the value of an argument as an integer (check with isArgInt).
char ** getArgv (void) const
 Gets the argv.
const char * getExtraString (void) const
 Gets the extra string of the input, used differently by different things.
const char * getFullString (void) const
 Gets the original string of the input.
bool isArgBool (size_t whichArg) const
 Sees if an argument is a bool.
bool isArgDouble (size_t whichArg) const
 Sees if an argument is a double.
bool isArgInt (size_t whichArg) const
 Sees if an argument is an int.
void log (void) const
 Prints out the arguments.
void removeArg (size_t which)
 Delete a particular arg, you MUST finish adding before you can remove.
void setExtraString (const char *str)
 Sets the extra string of the input, used differently by different things.
void setFullString (const char *str)
 Sets the full string (this is so you can have a more raw full string).
virtual ~ArArgumentBuilder ()
 Destructor.

Protected Member Functions

size_t getArgvLen (void) const
void internalAdd (const char *str, int position=-1)

Protected Attributes

size_t myArgc
char ** myArgv
size_t myArgvLen
std::string myExtraString
bool myFirstAdd
std::string myFullString
size_t myOrigArgc


Detailed Description

This class is to build arguments for things that require argc and argv.

Definition at line 33 of file ArArgumentBuilder.h.


Member Function Documentation

void ArArgumentBuilder::addPlain const char *  str,
int  position = -1
 

Adds the given string, without varargs (wrapper for java).

Parameters:
str the string to add
position the position to add the string at, a position less than 0 means to add at the end, if this number is greater than how many positions exist then it will also be added at the end

Definition at line 237 of file ArArgumentBuilder.cpp.

References internalAdd().

Referenced by ArArgumentParser::loadDefaultArguments(), and ArNetServer::runOnce().

void ArArgumentBuilder::addStrings int  argc,
char **  argv,
int  position = -1
 

Adds the given string thats divided.

Parameters:
argc how many arguments to add
argv the strings to add
position the position to add the string at, a position less than 0 means to add at the end, if this number is greater than how many positions exist then it will also be added at the end

Definition at line 262 of file ArArgumentBuilder.cpp.

References add().

void ArArgumentBuilder::addStrings char **  argv,
int  argc,
int  position = -1
 

Adds the given string thats divided.

Parameters:
argc how many arguments to add
argv the strings to add
position the position to add the string at, a position less than 0 means to add at the end, if this number is greater than how many positions exist then it will also be added at the end

Definition at line 249 of file ArArgumentBuilder.cpp.

Referenced by ArArgumentParser::addDefaultArgument(), and ArArgumentParser::loadDefaultArguments().

void ArArgumentBuilder::internalAdd const char *  str,
int  position = -1
[protected]
 

Internal function that adds a string starting at some given space

Parameters:
str the string to add
position the position to add the string at, a position less than 0 means to add at the end, if this number is greater than how many positions exist then it will also be added at the end

Definition at line 108 of file ArArgumentBuilder.cpp.

References ArLog::log().

Referenced by add(), and addPlain().


The documentation for this class was generated from the following files:
Generated on Wed Oct 19 12:56:43 2005 for Aria by  doxygen 1.4.0