optionExt Class Reference

#include <ScanInterface.hpp>

Collaboration diagram for optionExt:

Public Member Functions
	optionExt ()
	Set to true if this option was selected by the user. More...
	optionExt (const char *name_, const int &has_arg_, int *flag_, const int &val_, const std::string &arg_, const std::string &help_)
void	print (const size_t &len_=0, const std::string &prefix_="")
	Print a help string for this option. More...
option	getOption ()

Data Fields
const char *	name
int	has_arg
int *	flag
int	val
std::string	argstr
std::string	helpstr
	The argument syntax for the command line option. More...
std::string	argument
	The help & syntax string to print when -h is passed. More...
bool	active
	The argument received from getopt_long (if available). More...

Detailed Description

Definition at line 32 of file ScanInterface.hpp.

Constructor & Destructor Documentation

optionExt() [1/2]

optionExt::optionExt ( )

inline

Set to true if this option was selected by the user.

Definition at line 44 of file ScanInterface.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

optionExt() [2/2]

optionExt::optionExt	(	const char *	name_,
		const int &	has_arg_,
		int *	flag_,
		const int &	val_,
		const std::string &	arg_,
		const std::string &	help_
	)

Definition at line 46 of file ScanInterface.cpp.

Member Function Documentation

getOption()

option optionExt::getOption

(

)

Definition at line 63 of file ScanInterface.cpp.

Here is the caller graph for this function:

print()

void optionExt::print	(	const size_t &	len_ = 0,
		const std::string &	prefix_ = ""
	)

Print a help string for this option.

Definition at line 50 of file ScanInterface.cpp.

Here is the caller graph for this function:

Field Documentation

active

bool optionExt::active

The argument received from getopt_long (if available).

Definition at line 42 of file ScanInterface.hpp.

argstr

std::string optionExt::argstr

Definition at line 39 of file ScanInterface.hpp.

argument

std::string optionExt::argument

The help & syntax string to print when -h is passed.

Definition at line 41 of file ScanInterface.hpp.

flag

int* optionExt::flag

Definition at line 36 of file ScanInterface.hpp.

has_arg

int optionExt::has_arg

Definition at line 35 of file ScanInterface.hpp.

helpstr

std::string optionExt::helpstr

The argument syntax for the command line option.

Definition at line 40 of file ScanInterface.hpp.

name

const char* optionExt::name

Definition at line 34 of file ScanInterface.hpp.

val

int optionExt::val

Definition at line 37 of file ScanInterface.hpp.

---

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

• ScanInterface.hpp
• ScanInterface.cpp