vSMC  v3.0.0
Scalable Monte Carlo
Public Member Functions | List of all members
vsmc::ProgramOptionHelp Class Reference

Option --help More...

#include <vsmc/utility/program_option.hpp>

Public Member Functions

 ProgramOptionHelp ()
 
std::string default_str () const
 
std::string description () const
 
bool help () const
 
bool is_bool () const
 
bool is_vector () const
 
bool set (const std::string &name, const std::string &sval, bool silent, std::ostream &os)
 
bool set_default ()
 
- Public Member Functions inherited from vsmc::ProgramOption
 ProgramOption ()=default
 
 ProgramOption (const ProgramOption &)=default
 
virtual ~ProgramOption ()
 
ProgramOptionoperator= (const ProgramOption &)=default
 

Additional Inherited Members

- Protected Member Functions inherited from vsmc::ProgramOption
bool set_value (const std::string &name, const std::string &sval, bool *dest, bool silent, std::ostream &os)
 
bool set_value (const std::string &, const std::string &sval, std::string *dest, bool, std::ostream &)
 
template<typename T >
bool set_value (const std::string &name, const std::string &sval, T *dest, bool silent, std::ostream &os)
 

Detailed Description

Option --help

Definition at line 173 of file program_option.hpp.

Constructor & Destructor Documentation

vsmc::ProgramOptionHelp::ProgramOptionHelp ( )
inline

Definition at line 176 of file program_option.hpp.

Member Function Documentation

std::string vsmc::ProgramOptionHelp::default_str ( ) const
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 195 of file program_option.hpp.

std::string vsmc::ProgramOptionHelp::description ( ) const
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 190 of file program_option.hpp.

bool vsmc::ProgramOptionHelp::help ( ) const
inline

Definition at line 197 of file program_option.hpp.

bool vsmc::ProgramOptionHelp::is_bool ( ) const
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 178 of file program_option.hpp.

bool vsmc::ProgramOptionHelp::is_vector ( ) const
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 180 of file program_option.hpp.

bool vsmc::ProgramOptionHelp::set ( const std::string &  name,
const std::string &  sval,
bool  silent,
std::ostream &  os 
)
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 182 of file program_option.hpp.

bool vsmc::ProgramOptionHelp::set_default ( )
inlinevirtual

Implements vsmc::ProgramOption.

Definition at line 188 of file program_option.hpp.