artefaktur
software engineer &        architecture

 
 
 
 

class CmdLineOption

Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::lang::CmdLineOption Class Reference

#include <CmdLineOption.h>

Inheritance diagram for acdk::lang::CmdLineOption:

acdk::lang::Object acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch List of all members.

Detailed Description

CmdLineOption represent a option in a command line and returns the options.

Author:
Roger Rene Kommer
Version:
Revision
1.9
Date:
Date
2005/02/05 10:44:55
See also:
CmdLineParser


Public Member Functions

 CmdLineOption (IN(RString) option, IN(RString) alias, bool expectArg, IN(RString) help, bool required=false)
 CmdLineOption (IN(RString) option, IN(RString) shortoption, IN(RString) alias, bool expectArg, IN(RString) help, bool required=false)
void printOn (IN(::acdk::io::RPrintWriter) out)

Public Attributes

RString _option
 the option as string like: -v -value

RString _shortOption
 like -v

RString _alias
 the alias.

bool _expectArg
 if set, option what to have an value -acdk-opt=value or -acdk-opt value

RString _docText
 documents the option

bool _required
 This options has to be specified.

bool _parsed
 This options is detected.


Constructor & Destructor Documentation

acdk::lang::CmdLineOption::CmdLineOption IN(RString option,
IN(RString alias,
bool  expectArg,
IN(RString help,
bool  required = false
[inline]
 

acdk::lang::CmdLineOption::CmdLineOption IN(RString option,
IN(RString shortoption,
IN(RString alias,
bool  expectArg,
IN(RString help,
bool  required = false
[inline]
 


Member Function Documentation

void acdk::lang::CmdLineOption::printOn IN(::acdk::io::RPrintWriter out  ) 
 


Member Data Documentation

RString acdk::lang::CmdLineOption::_alias
 

the alias.

if this is not Nil, this value will be used as key in the Property

RString acdk::lang::CmdLineOption::_docText
 

documents the option

bool acdk::lang::CmdLineOption::_expectArg
 

if set, option what to have an value -acdk-opt=value or -acdk-opt value

if not set, value is 1 if option is set

RString acdk::lang::CmdLineOption::_option
 

the option as string like: -v -value

bool acdk::lang::CmdLineOption::_parsed
 

This options is detected.

bool acdk::lang::CmdLineOption::_required
 

This options has to be specified.

RString acdk::lang::CmdLineOption::_shortOption
 

like -v

 
Last modified 2005-05-08 18:32 by SYSTEM By Artefaktur, Ing. Bureau Kommer