Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
qgar::QgarArgs::QgarParam

qgar::QgarArgs::QgarParam Class Reference
[Application coding]

#include <QgarArgs.H>

List of all members.

Detailed Description

Internal representation of an application parameter.

Inner class of class qgar::QgarArgs

Todo:
Complete the documentation
Author:
Philippe Dosch
Date:
July 02, 2001 17:20
Since:
Qgar 1.0

Definition at line 305 of file QgarArgs.H.

Public Member Functions

Constructors
 QgarParam (const char *aParamName, QGEparamStatus aParamStatus, QGEparamType aParamType, const char *aDescription, const char *anExtension=0, const char *aDefault=0)
 Construct from full data.
Access
QGEparamStatus paramStatus () const
 Get the parameter status.
bool useFlag () const
 Get flag for use.
const char * name () const
 Get parameter name.
const char * value (bool aSpecial)
 Get parameter value.
int numbOptions () const
 Get parameter number.
const char * argument (int anIdx)
 Get indexed argument.
const char * description () const
 Get parameter description.
bool newValue () const
 Get new value.
Transformation
void setUseFlag (bool aBool=true)
 Set flag for use (default true).
void setValue (char *aVal)
 Set parameter value.
void setNewValue (char *aVal)
 Set new value.
void addArgument (char *anArg)
 Add an argument to the argument list.
Display
void printGUI (bool anEndl) const
 Display information about the parameter on standard output.
void showUsage () const
 Display usage message on standard output.

Protected Attributes

Parameter features
const char * _name
 Parameter name.
const char * _description
 Parameter description.
bool _useFlag
 Flag...
QGEparamStatus _paramStatus
 Parameter status.
QGEparamType _paramType
 Parameter type.
const char * _extension
 File extension.
Parameter values
const char * _default
 Parameter default value.
char * _value
 Parameter value.
bool _newValue
 Parameter new value.
std::vector< char * > _args
 Parameter arguments.

Constructor & Destructor Documentation

qgar::QgarArgs::QgarParam::QgarParam (  const char *  aParamName,
QGEparamStatus  aParamStatus,
QGEparamType  aParamType,
const char *  aDescription,
const char *  anExtension = 0,
const char *  aDefault = 0
) 
 

Construct from full data.

Parameters:
aParamName parameter name, first character is a minus (e.g. -f)
aParamStatus parameter status (see enum type qgar::QgarArgs::ParamStatus)
aParamType parameter type (see enum type qgar::QgarArgs::ParamType)
aDescription short description of the parameter
anExtension file extension, in case of an output file
aDefault default value (given as a string) for a parameter which is not a file

Definition at line 76 of file QgarArgs.C.

Member Function Documentation

void qgar::QgarArgs::QgarParam::addArgument (  char *  anArg  )  [inline]
 

Add an argument to the argument list.

Parameters:
anArg argument to be added

Definition at line 874 of file QgarArgs.H.

References _args.

Referenced by qgar::QgarArgs::analyzeLine().

const char * qgar::QgarArgs::QgarParam::argument (  int  anIdx  )  [inline]
 

Get indexed argument.

Parameters:
anIdx argument index.

Definition at line 814 of file QgarArgs.H.

References _args.

Referenced by qgar::QgarArgs::getStringOptionMulti().

const char * qgar::QgarArgs::QgarParam::description (   )  const [inline]
 

Get parameter description.

Definition at line 823 of file QgarArgs.H.

References _description.

const char * qgar::QgarArgs::QgarParam::name (   )  const [inline]
 

Get parameter name.

Definition at line 796 of file QgarArgs.H.

References _name.

bool qgar::QgarArgs::QgarParam::newValue (   )  const [inline]
 

Get new value.

Definition at line 832 of file QgarArgs.H.

References _newValue.

Referenced by qgar::QgarApp::newValue().

int qgar::QgarArgs::QgarParam::numbOptions (   )  const [inline]
 

Get parameter number.

Definition at line 805 of file QgarArgs.H.

References _args.

Referenced by qgar::QgarArgs::getNumberOptions(), and qgar::QgarArgs::getStringOptionMulti().

QgarArgs::QGEparamStatus qgar::QgarArgs::QgarParam::paramStatus (   )  const [inline]
 

Get the parameter status.

Definition at line 778 of file QgarArgs.H.

References _paramStatus.

Referenced by qgar::QgarArgs::analyzeLine(), qgar::QgarArgs::getNumberOptions(), qgar::QgarArgs::getStringOption(), qgar::QgarArgs::getStringOptionMulti(), and qgar::QgarArgs::isOptionSet().

void qgar::QgarArgs::QgarParam::printGUI (  bool  anEndl  )  const
 

Display information about the parameter on standard output.

Parameters:
anEndl 

Definition at line 123 of file QgarArgs.C.

References _default, _description, _extension, _name, _paramStatus, _paramType, qgar::QgarArgs::BOOL, qgar::QgarArgs::FILEIN, qgar::QgarArgs::FILEOUT, qgar::QgarArgs::FILEOUTD, qgar::QgarArgs::FILEOUTDS, qgar::QgarArgs::FLOAT, qgar::QgarArgs::INT, qgar::QgarArgs::PATH, qgar::QgarArgs::REQMULTIPARAM, qgar::QgarArgs::REQPARAM, and qgar::QgarArgs::STRING.

Referenced by qgar::QgarApp::showDialog().

void qgar::QgarArgs::QgarParam::setNewValue (  char *  aVal  )  [inline]
 

Set new value.

Parameters:
aVal value to assign

Definition at line 864 of file QgarArgs.H.

References _newValue, and setValue().

Referenced by qgar::QgarArgs::setParamValue().

void qgar::QgarArgs::QgarParam::setUseFlag (  bool  aBool = true  )  [inline]
 

Set flag for use (default true).

Parameters:
aBool new value of the flag

Definition at line 846 of file QgarArgs.H.

References _useFlag.

Referenced by qgar::QgarArgs::analyzeLine().

void qgar::QgarArgs::QgarParam::setValue (  char *  aVal  )  [inline]
 

Set parameter value.

Parameters:
aVal new value of the parameter

Definition at line 855 of file QgarArgs.H.

References _value.

Referenced by qgar::QgarArgs::analyzeLine(), and setNewValue().

void qgar::QgarArgs::QgarParam::showUsage (   )  const
 

Display usage message on standard output.

Definition at line 204 of file QgarArgs.C.

References _description, _name, _paramStatus, _paramType, qgar::QgarArgs::BOOL, qgar::QgarArgs::FILEIN, qgar::QgarArgs::FILEOUT, qgar::QgarArgs::FILEOUTD, qgar::QgarArgs::FILEOUTDS, qgar::QgarArgs::FLOAT, qgar::QgarArgs::INT, qgar::QgarArgs::PATH, qgar::QgarArgs::REQMULTIPARAM, qgar::QgarArgs::REQPARAM, and qgar::QgarArgs::STRING.

bool qgar::QgarArgs::QgarParam::useFlag (   )  const [inline]
 

Get flag for use.

Definition at line 787 of file QgarArgs.H.

References _useFlag.

Referenced by qgar::QgarArgs::isOptionSet().

const char * qgar::QgarArgs::QgarParam::value (  bool  aSpecial  ) 
 

Get parameter value.

Parameters:
aSpecial 

Definition at line 104 of file QgarArgs.C.

References _newValue, and _value.

Referenced by qgar::QgarArgs::getStringOption().

Member Data Documentation

std::vector<char*> qgar::QgarArgs::QgarParam::_args [protected]
 

Parameter arguments.

Definition at line 505 of file QgarArgs.H.

Referenced by addArgument(), argument(), and numbOptions().

const char* qgar::QgarArgs::QgarParam::_default [protected]
 

Parameter default value.

Definition at line 490 of file QgarArgs.H.

Referenced by printGUI().

const char* qgar::QgarArgs::QgarParam::_description [protected]
 

Parameter description.

Definition at line 458 of file QgarArgs.H.

Referenced by description(), printGUI(), and showUsage().

const char* qgar::QgarArgs::QgarParam::_extension [protected]
 

File extension.

Definition at line 478 of file QgarArgs.H.

Referenced by printGUI().

const char* qgar::QgarArgs::QgarParam::_name [protected]
 

Parameter name.

Definition at line 453 of file QgarArgs.H.

Referenced by name(), printGUI(), and showUsage().

bool qgar::QgarArgs::QgarParam::_newValue [protected]
 

Parameter new value.

Definition at line 500 of file QgarArgs.H.

Referenced by newValue(), setNewValue(), and value().

QGEparamStatus qgar::QgarArgs::QgarParam::_paramStatus [protected]
 

Parameter status.

Definition at line 468 of file QgarArgs.H.

Referenced by paramStatus(), printGUI(), and showUsage().

QGEparamType qgar::QgarArgs::QgarParam::_paramType [protected]
 

Parameter type.

Definition at line 473 of file QgarArgs.H.

Referenced by printGUI(), and showUsage().

bool qgar::QgarArgs::QgarParam::_useFlag [protected]
 

Flag...

Definition at line 463 of file QgarArgs.H.

Referenced by setUseFlag(), and useFlag().

char* qgar::QgarArgs::QgarParam::_value [protected]
 

Parameter value.

Definition at line 495 of file QgarArgs.H.

Referenced by setValue(), and value().

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