carto::OptionBase Class Reference

#include <soma-io/getopt/getopt.h>

Inheritance diagram for carto::OptionBase:

Collaboration diagram for carto::OptionBase:

Public Member Functions
virtual std::string	info () const =0

Protected Member Functions
virtual bool	recognizeName (const std::string &)=0
virtual bool	feed (const std::string &)=0
virtual void	check ()=0
	OptionBase (const std::string &name, const std::string &info)
virtual	~OptionBase ()
void	addName (const std::string &name)
const std::string &	name () const
std::string	names () const
bool	_nameInList (const std::string &name) const

Protected Attributes
std::vector< std::string >	_names
std::string	_info

Friends
class	OptionsParser

Detailed Description

Definition at line 96 of file getopt.h.

Constructor & Destructor Documentation

OptionBase()

carto::OptionBase::OptionBase ( const std::string & name, const std::string & info )

protected

References info(), and name().

Referenced by carto::SingleOption< T >::SingleOption().

~OptionBase()

carto::OptionBase::~OptionBase ( )

inlineprotectedvirtual

Definition at line 125 of file getopt.h.

Member Function Documentation

_nameInList()

bool carto::OptionBase::_nameInList ( const std::string & name ) const

inlineprotected

Definition at line 139 of file getopt.h.

References _names, and name().

Referenced by carto::SingleOption< T >::recognizeName(), and carto::SingleOption< BoolOrNumber< NumberType > >::recognizeName().

addName()

void carto::OptionBase::addName ( const std::string & name )

inlineprotected

Definition at line 128 of file getopt.h.

References _names, and name().

check()

virtual void carto::OptionBase::check ( )

protectedpure virtual

Implemented in carto::SingleOption< T >, carto::SingleOption< BoolOrNumber< NumberType > >, and carto::SingleOption< NumberType >.

feed()

virtual bool carto::OptionBase::feed ( const std::string & )

protectedpure virtual

Implemented in carto::SingleOption< T >, carto::SingleOption< T >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< NumberType >, carto::SingleOption< NumberType >, and carto::SingleOption< NumberType >.

info()

virtual std::string carto::OptionBase::info ( ) const

pure virtual

Implemented in carto::SingleOption< T >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, and carto::SingleOption< NumberType >.

Referenced by OptionBase().

name()

const std::string & carto::OptionBase::name ( ) const

inlineprotected

Definition at line 133 of file getopt.h.

References _names.

Referenced by _nameInList(), addName(), carto::SingleOption< T >::check(), names(), OptionBase(), carto::OptionSeries< T >::OptionsParser, carto::SingleOption< T >::SingleOption(), carto::SingleOption< BoolOrNumber< NumberType > >::SingleOption(), and carto::SingleOption< NumberType >::SingleOption().

names()

std::string carto::OptionBase::names ( ) const

protected

References name().

Referenced by carto::SingleOption< T >::info(), and carto::SingleOption< BoolOrNumber< NumberType > >::info().

recognizeName()

virtual bool carto::OptionBase::recognizeName ( const std::string & )

protectedpure virtual

Implemented in carto::SingleOption< T >, carto::SingleOption< T >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< BoolOrNumber< NumberType > >, carto::SingleOption< NumberType >, carto::SingleOption< NumberType >, and carto::SingleOption< NumberType >.

Friends And Related Symbol Documentation

OptionsParser

friend class OptionsParser

friend

Definition at line 98 of file getopt.h.

References OptionsParser.

Referenced by OptionsParser.

Member Data Documentation

_info

std::string carto::OptionBase::_info

protected

Definition at line 103 of file getopt.h.

Referenced by carto::SingleOption< T >::info(), and carto::SingleOption< BoolOrNumber< NumberType > >::info().

_names

std::vector<std::string> carto::OptionBase::_names

protected

Definition at line 102 of file getopt.h.

Referenced by _nameInList(), addName(), and name().

---

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

• soma-io/getopt/getopt.h