oasys::CharBufOpt Class Reference

#include <Options.h>

Inheritance diagram for oasys::CharBufOpt:

oasys::Opt List of all members.

Detailed Description

Char buffer option class.

Definition at line 392 of file Options.h.

Public Member Functions

 CharBufOpt (const char *opt, char *valp, size_t *lenp, size_t buflen, const char *valdesc="", const char *desc="", bool *setp=NULL)
 Basic constructor.
 CharBufOpt (char shortopt, const char *longopt, char *valp, size_t *lenp, size_t buflen, const char *valdesc="", 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.

Protected Attributes

size_t buflen_
size_t * lenp_


Constructor & Destructor Documentation

oasys::CharBufOpt::CharBufOpt ( const char *  opt,
char *  valp,
size_t *  lenp,
size_t  buflen,
const char *  valdesc = "",
const char *  desc = "",
bool setp = NULL 
)

Basic constructor.

Parameters:
opt the option string
valp pointer to the value
lenp pointer to the length
buflen length of the buffer
valdesc short description for the value
desc descriptive string
setp optional pointer to indicate whether or not the option was set

Definition at line 386 of file Options.cc.

oasys::CharBufOpt::CharBufOpt ( char  shortopt,
const char *  longopt,
char *  valp,
size_t *  lenp,
size_t  buflen,
const char *  valdesc = "",
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
lenp pointer to the length
buflen length of the buffer
valdesc short description for the value
desc descriptive string
setp optional pointer to indicate whether or not the option was set

Definition at line 393 of file Options.cc.


Member Function Documentation

int oasys::CharBufOpt::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 403 of file Options.cc.

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

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

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

Implements oasys::Opt.

Definition at line 421 of file Options.cc.

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


Member Data Documentation

size_t oasys::CharBufOpt::buflen_ [protected]

Definition at line 430 of file Options.h.

Referenced by set().

size_t* oasys::CharBufOpt::lenp_ [protected]

Definition at line 431 of file Options.h.

Referenced by get(), and set().


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