CmdLine Struct Reference

Represents all application call parameters. More...

#include <cmdline.h>

List of all members.

Public Member Functions

 CmdLine (ISTREAM_TYPE _query_istream_type, ISTREAM_TYPE _xml_istream_type, OSTREAM_TYPE _eout_ostream_type, OSTREAM_TYPE _dout_ostream_type, const char *_query_arg, const char *_xml_arg, const char *_eout_arg, const char *_dout_arg, bool _debug, bool _preprocess_stream_debug, bool _preprocess_stream_no_debug)
 Constructor.
virtual ~CmdLine ()
void checkIntegrity ()
 Checks if required/sufficient parameters have been passed.

Public Attributes

ISTREAM_TYPE query_istream_type
 The query input stream type.
ISTREAM_TYPE xml_istream_type
 The XML document input stream type.
OSTREAM_TYPE eout_ostream_type
 The evaluate/result output stream type.
OSTREAM_TYPE dout_ostream_type
 The debug output stream type.
const char * query_arg
 The required argument for query input stream.
const char * xml_arg
 The required argument for XML document input stream.
const char * eout_arg
 The required argument for evaluate/result output stream.
const char * dout_arg
 The required argument for debug output stream.
bool debug
 Indicator for debug-mode.
bool preprocess_stream_debug
 Indicator for preprocess-stream-mode (including debug-mode).
bool preprocess_stream_no_debug
 Indicator for preprocess-stream-mode (excluding debug-mode).


Detailed Description

Represents all application call parameters.

Represents all application call parameters, which have been passed to save them.

Author:
Michael Schmidt

Gunnar Jehl

Version:
2.1
License:
Software License Agreement (BSD License)

Definition at line 53 of file cmdline.h.


Constructor & Destructor Documentation

CmdLine::CmdLine ( ISTREAM_TYPE  _query_istream_type,
ISTREAM_TYPE  _xml_istream_type,
OSTREAM_TYPE  _eout_ostream_type,
OSTREAM_TYPE  _dout_ostream_type,
const char *  _query_arg,
const char *  _xml_arg,
const char *  _eout_arg,
const char *  _dout_arg,
bool  _debug,
bool  _preprocess_stream_debug,
bool  _preprocess_stream_no_debug 
)

Constructor.

Constructor - creating object for all parameters.

Parameters:
[in] _query_istream_type ISTREAM_TYPE.
[in] _xml_istream_type ISTREAM_TYPE.
[in] _eout_ostream_type OSTREAM_TYPE.
[in] _dout_ostream_type OSTREAM_TYPE.
[in] _query_arg Pointer to a char object (e.g. path to a file).
[in] _xml_arg Pointer to a char object (e.g. path to a file).
[in] _eout_arg Pointer to a char object (e.g. path to a file).
[in] _dout_arg Pointer to a char object (e.g. path to a file).
[in] _debug true in debug-mode, false otherwise.
[in] _preprocess_stream_debug true in preprocess-stream-mode (including debug-mode), false otherwise.
[in] _preprocess_stream_no_debug true in preprocess-stream-mode (excluding debug-mode), false otherwise.

Definition at line 37 of file cmdline.cpp.

CmdLine::~CmdLine (  )  [virtual]

Destructor.

Definition at line 59 of file cmdline.cpp.


Member Function Documentation

void CmdLine::checkIntegrity (  ) 

Checks if required/sufficient parameters have been passed.

Checks if required/sufficient parameters have been passed.

Exceptions:
InvalidArgumentException If wrong or missing parameter is given.
Return values:
void 

Definition at line 67 of file cmdline.cpp.

References dout_arg, dout_ostream_type, eout_arg, eout_ostream_type, query_arg, query_istream_type, and xml_istream_type.

Referenced by main().


Member Data Documentation

const char * CmdLine::dout_arg

The required argument for debug output stream.

The required argument for debug output stream, which is the eigth argument of the constructor.

Definition at line 133 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

The debug output stream type.

The debug output stream type, which is the fourth argument of the constructor.

Definition at line 109 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

const char * CmdLine::eout_arg

The required argument for evaluate/result output stream.

The required argument for evaluate/result output stream, which is the seventh argument of the constructor.

Definition at line 127 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

The evaluate/result output stream type.

The evaluate/result output stream type, which is the third argument of the constructor.

Definition at line 103 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

Indicator for preprocess-stream-mode (including debug-mode).

Indicator for preprocess-stream-mode (including debug-mode), which is the tenth argument of the constructor.

Definition at line 145 of file cmdline.h.

Referenced by Executor::start().

Indicator for preprocess-stream-mode (excluding debug-mode).

Indicator for preprocess-stream-mode (excluding debug-mode), which is the eleventh argument of the constructor.

Definition at line 151 of file cmdline.h.

Referenced by Executor::start().

const char * CmdLine::query_arg

The required argument for query input stream.

The required argument for query input stream, which is the fifth argument of the constructor.

Definition at line 115 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

The query input stream type.

The query input stream type, which is the first argument of the constructor.

Definition at line 91 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().

const char * CmdLine::xml_arg

The required argument for XML document input stream.

The required argument for XML document input stream, which is the sixth argument of the constructor.

Definition at line 121 of file cmdline.h.

Referenced by Executor::initStreams().

The XML document input stream type.

The XML document input stream type, which is the second argument of the constructor.

Definition at line 97 of file cmdline.h.

Referenced by checkIntegrity(), and Executor::initStreams().


Generated on Sun May 24 20:20:21 2009 for G(arbage) C(ollected) X(Query) Engine by  doxygen 1.5.9