settings Class Reference

#include <settings.h>

Collaboration diagram for settings:

List of all members.

---

Detailed Description

Settings singleton class.

Public Member Functions
void	Show (void)
	Show the settings (DEBUG).
bool	GetRecursive (void)
	Get de setting recursive.
bool	GetDebug (void)
	Get de setting debug.
bool	GetShowHelp (void)
	Get de setting show help.
bool	GetShowVersion (void)
	Get de setting show version.
string	GetOriginalRoute (void)
	Get de setting original route.
string	GetFileRoute (void)
	Get de setting file route.
string	GetOutFile (void)
	Get de setting out file.
string	GetLogFile (void)
	Get de setting log file.
string	GetLabel (void)
	Get de setting label.
string	GetFormat (void)
	Get de setting format.
Static Public Member Functions
void	CreateInstance (int argc, char **argv)
	Create the settings singleton instance.
void	DeleteInstance (void)
	Deletes the settings singleton instance.
settings *	Instance (void)
	Get de settings singleton instance.
Private Member Functions
	settings (int argc, char **argv)
	Settings constructor.
	settings (const settings &Obj)
	Settings copy constructor.
void	SetDefaults (void)
	Set the default settings.
void	SetArguments (list< string > ArgumentsList)
	Set the settings from the arguments passed to the command line.
bool	ParseArgument (list< string >::const_iterator ArgsIterator, list< string >::const_iterator ArgsIteratorEnd)
	Parses an argument.
void	ParseArgument (char Argument)
	Parses an argument.
Private Attributes
bool	m_Recursive
	true: Search in specified directory and subdirectories. (--recursive)
bool	m_Debug
	true: Show debug messages. (--debug)
bool	m_ShowHelp
	true: Show help message. (--help)
bool	m_ShowVersion
	true: Show version message. (--version)
string	m_OriginalRoute
	String with the original route.
string	m_FileRoute
	String with the file/route. (--route).
string	m_OutFile
	String with the output filename. (--out).
string	m_LogFile
	String with the log filename. (--log).
string	m_Label
	String with the label name. (--label).
string	m_Format
	String with the file of output Format. (--format).
Static Private Attributes
settings *	m_pInstance = NULL
	Singleton instance.

---

Constructor & Destructor Documentation

settings::settings (  int  argc, char **  argv )  [private]

Settings constructor. Parameters: argc:  Number of arguments. argv:  Vector of arguments.

Here is the call graph for this function:

settings::settings (  const settings &  Obj  )  [private]

Settings copy constructor. Parameters: Obj:  Object instance.

---

Member Function Documentation

void settings::CreateInstance (  int  argc, char **  argv )  [static]

Create the settings singleton instance. Parameters: argc:  Number of arguments. argv:  Vector of arguments.

Here is the call graph for this function:

void settings::DeleteInstance (  void   )  [static]

Deletes the settings singleton instance.

settings * settings::Instance (  void   )  [static]

Get de settings singleton instance. Returns: pointer to the current instance.

void settings::Show (  void   )

Show the settings (DEBUG).

Here is the call graph for this function:

bool settings::GetRecursive (  void   )

Get de setting recursive. Returns: Recursive flag.

bool settings::GetDebug (  void   )

Get de setting debug. Returns: Debug flag.

bool settings::GetShowHelp (  void   )

Get de setting show help. Returns: Show help flag.

bool settings::GetShowVersion (  void   )

Get de setting show version. Returns: Show version flag.

string settings::GetOriginalRoute (  void   )

Get de setting original route. Returns: Original route.

string settings::GetFileRoute (  void   )

Get de setting file route. Returns: File route.

string settings::GetOutFile (  void   )

Get de setting out file. Returns: Output file name.

string settings::GetLogFile (  void   )

Get de setting log file. Returns: Log file name.

string settings::GetLabel (  void   )

Get de setting label. Returns: Label.

string settings::GetFormat (  void   )

Get de setting format. Returns: String with the format file.

void settings::SetDefaults (  void   )  [private]

Set the default settings.

Here is the call graph for this function:

void settings::SetArguments (  list< string >  ArgsList  )  [private]

Set the settings from the arguments passed to the command line. Parameters: ArgsList:  Number of arguments.

Here is the call graph for this function:

bool settings::ParseArgument (  list< string >::const_iterator  ArgsIterator, list< string >::const_iterator  ArgsIteratorEnd )  [private]

Parses an argument. Parameters: ArgsIterator:  Argument iterator. ArgsIteratorEnd:  Argument iterator end. Returns: True if a sub argument was used, else false.

Here is the call graph for this function:

void settings::ParseArgument (  char  Argument  )  [private]

Parses an argument. Parameters: Argument:  Argument to be parsed.

---

Member Data Documentation

bool settings::m_Recursive [private]

true: Search in specified directory and subdirectories. (--recursive)

bool settings::m_Debug [private]

true: Show debug messages. (--debug)

bool settings::m_ShowHelp [private]

true: Show help message. (--help)

bool settings::m_ShowVersion [private]

true: Show version message. (--version)

string settings::m_OriginalRoute [private]

String with the original route.

string settings::m_FileRoute [private]

String with the file/route. (--route).

string settings::m_OutFile [private]

String with the output filename. (--out).

string settings::m_LogFile [private]

String with the log filename. (--log).

string settings::m_Label [private]

String with the label name. (--label).

string settings::m_Format [private]

String with the file of output Format. (--format).

settings * settings::m_pInstance = NULL [static, private]

Singleton instance.

---

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

• settings.h
• settings.cpp

---