oasys::BoolOpt Class Reference

#include <Options.h>

Inheritance diagram for oasys::BoolOpt:

oasys::Opt List of all members.

Detailed Description

Boolean option class.

Definition at line 76 of file Options.h.

Public Member Functions

 BoolOpt (const char *opt, bool *valp, const char *desc="", bool *setp=NULL)
 Basic constructor.
 BoolOpt (char shortopt, const char *longopt, bool *valp, const char *desc="", bool *setp=NULL)
 Alternative constructor with both short and long options, suitable for getopt calls.

Protected Member Functions

int set (const char *val, size_t len)
 Virtual callback to set the option to the given string value.
void get (StringBuffer *buf)
 Virtual callback to get a string version of the current value.


Constructor & Destructor Documentation

oasys::BoolOpt::BoolOpt ( const char *  opt,
bool valp,
const char *  desc = "",
bool setp = NULL 
)

Basic constructor.

Parameters:
opt the option string
valp pointer to the value
desc descriptive string
setp optional pointer to indicate whether or not the option was set

Definition at line 54 of file Options.cc.

oasys::BoolOpt::BoolOpt ( char  shortopt,
const char *  longopt,
bool valp,
const char *  desc = "",
bool setp = NULL 
)

Alternative constructor with both short and long options, suitable for getopt calls.

Parameters:
shortopt short option character
longopt long option string
valp pointer to the value
desc descriptive string
setp optional pointer to indicate whether or not the option was set

Definition at line 61 of file Options.cc.


Member Function Documentation

int oasys::BoolOpt::set ( const char *  val,
size_t  len 
) [protected, virtual]

Virtual callback to set the option to the given string value.

Implements oasys::Opt.

Definition at line 69 of file Options.cc.

References oasys::Opt::setp_, and oasys::Opt::valp_.

void oasys::BoolOpt::get ( StringBuffer buf  )  [protected, virtual]

Virtual callback to get a string version of the current value.

Implements oasys::Opt.

Definition at line 97 of file Options.cc.

References oasys::StringBuffer::appendf(), and oasys::Opt::valp_.


The documentation for this class was generated from the following files:
Generated on Thu Jun 7 16:57:02 2007 for DTN Reference Implementation by  doxygen 1.5.1