UCommon
Public Member Functions | Protected Member Functions | Protected Attributes
ucommon::shell::counteropt Class Reference

Counter option for shell parsing. More...

#include <shell.h>

Inheritance diagram for ucommon::shell::counteropt:
Inheritance graph
[legend]
Collaboration diagram for ucommon::shell::counteropt:
Collaboration graph
[legend]

Public Member Functions

 counteropt (char short_option, const char *long_option=NULL, const char *help=NULL, const char *type="numeric", long def_value=0)
 operator bool ()
 operator long ()
bool operator! ()
long operator* ()
void set (long value)

Protected Member Functions

virtual const char * assign (const char *value)
 Used to send option into derived receiver.

Protected Attributes

long number

Detailed Description

Counter option for shell parsing.

This offers a quick-use class to parse a shell flag, along with a numeric value that may be saved and a use counter, as multiple invocations is an error. Unlike numeric options, the short mode flag is a trigger option, and each use of the short flag is considered a counter increment.

Author:
David Sugar <dyfet@gnutelephony.org>

Member Function Documentation

virtual const char* ucommon::shell::counteropt::assign ( const char *  value) [protected, virtual]

Used to send option into derived receiver.

Parameters:
valueoption that was received.
Returns:
NULL or error string to use.

Implements ucommon::shell::Option.


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