Arguments Class Reference

Parses and sets the arguments for main(). More...

#include <Arguments.h>

List of all members.

Public Types

enum  arguments {
  NO_ARG, AIML, AIML_SCHEMA, COMMON_SCHEMA,
  BOT_SCHEMA, RESOURCES, CONFIGURATION
}
 Enumeration of possible switches you can give rebecca. More...

Public Member Functions

string getAimlDirectory () const
 Returns the AIML directory that has been set.
string getAimlSchemaPath () const
 Returns the AIML schema path that has been set.
string getBotConfigurationSchemaPath () const
 Returns the bot configuration schema path that has been set.
string getCommonTypesSchemaPath () const
 Returns the common types schema path that has been set.
string getConfigurationDirectory () const
 Returns the configuration directory that has been set.
string getResourcesDirectory () const
 Returns the resource directory.

Static Public Member Functions

static ArgumentsgetInstance ()
 Gets our single instance of this class.
static void setArguments (int argc, char *args[])
 Sets the arguments up from main() as well as the program name its self.

Public Attributes

string m_aimlDirectory
 The location of a AIML directory.
string m_aimlSchemaPath
 The path to the aiml xsd file.
string m_botConfigurationSchemaPath
 The path to the bot configuration schema file.
string m_commonTypesSchemaPath
 The path to the the common types schema file.
string m_configurationDirectory
 The location of RebeccaAIML's configuration directory.
arguments m_currentArgument
 The current argument state.
string m_resourcesDirectory
 The location of the resources directory.

Private Member Functions

 Arguments ()
 Constructor that sets the arguments up from main() as well as the program name its self.
void privateSetArguments (int argc, char *args[])
 Sets the arguments up from main() as well as the program name its self.

Static Private Attributes

static Argumentsm_instance = 0
 Holds the reference to our singelton reference.


Detailed Description

Parses and sets the arguments for main().


Member Enumeration Documentation

enum arguments
 

Enumeration of possible switches you can give rebecca.


Constructor & Destructor Documentation

Arguments  )  [inline, private]
 

Constructor that sets the arguments up from main() as well as the program name its self.

This is a default constructor that sets default values for everything.


Member Function Documentation

string getAimlDirectory  )  const [inline]
 

Returns the AIML directory that has been set.

Returns:
The AIML directory where aiml files are stored.

string getAimlSchemaPath  )  const [inline]
 

Returns the AIML schema path that has been set.

Returns:
The AIML schema path that has been set.

string getBotConfigurationSchemaPath  )  const [inline]
 

Returns the bot configuration schema path that has been set.

Returns:
the bot configuration schema path that has been set.

string getCommonTypesSchemaPath  )  const [inline]
 

Returns the common types schema path that has been set.

Returns:
The common types schema path that has been set.

string getConfigurationDirectory  )  const [inline]
 

Returns the configuration directory that has been set.

Returns:
The configuration directory where needed configuration files are stored.

static Arguments* getInstance  )  [inline, static]
 

Gets our single instance of this class.

Returns:
the single instance of this class

string getResourcesDirectory  )  const [inline]
 

Returns the resource directory.

Returns:
the resource directory.

void privateSetArguments int  argc,
char *  args[]
[inline, private]
 

Sets the arguments up from main() as well as the program name its self.

Parameters:
argc The number of arguments sent in.
args The array of arguments

static void setArguments int  argc,
char *  args[]
[inline, static]
 

Sets the arguments up from main() as well as the program name its self.

Parameters:
argc The number of arguments sent in.
args The array of arguments


Member Data Documentation

string m_aimlDirectory
 

The location of a AIML directory.

If this is not set, it will default to the current working directory + "../../aiml/annotated_alice".

string m_aimlSchemaPath
 

The path to the aiml xsd file.

If this is not set, it will default to the current working directory + "../../resources/schema/AIML.xsd"

string m_botConfigurationSchemaPath
 

The path to the bot configuration schema file.

If this is not set, it will default to the current working directory + "../resources/schema/bot-configuration.xsd"

string m_commonTypesSchemaPath
 

The path to the the common types schema file.

If this is not set, it will default to the current working directory + "../resources/schema/common-types.xsd"

string m_configurationDirectory
 

The location of RebeccaAIML's configuration directory.

If this is not set, it will default to the current working directory + "../../conf". This is where needed configuration files are stored.

arguments m_currentArgument
 

The current argument state.

Arguments * m_instance = 0 [static, private]
 

Holds the reference to our singelton reference.

string m_resourcesDirectory
 

The location of the resources directory.

If this is not set, it will default to current working directory + "../../resources"


The documentation for this class was generated from the following files:
Generated on Wed Jul 26 21:39:07 2006 for RebeccaAIML by  doxygen 1.4.5