libjmmcg  release_579_6_g8cffd
A C++ library containing an eclectic mix of useful, advanced components.
jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ > Class Template Referenceabstract

A specialization for helping to making use of configuration files. More...

#include <cmd_line_processing.hpp>

Inheritance diagram for jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >:
[legend]
Collaboration diagram for jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >:
[legend]

Public Types

typedef CmdLineProcessorBase< ProgOpts, Except_ >::ProgramOptions ProgramOptions
 
typedef CmdLineProcessorBase< ProgOpts, Except_ >::exception exception_t
 
- Public Types inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineProcessorBase< ProgOpts, Except_ >
typedef ProgOpts ProgramOptions
 
typedef Except_ exception_type
 

Public Member Functions

__stdcall ConfigFile (ProgramOptions &p)
 
 ConfigFile (ConfigFile const &)=delete
 
virtual __stdcall ~ConfigFile ()
 
- Public Member Functions inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineProcessorBase< ProgOpts, Except_ >
__stdcall CmdLineProcessorBase (ProgramOptions &)
 
 CmdLineProcessorBase (CmdLineProcessorBase const &)=delete
 
virtual __stdcall ~CmdLineProcessorBase (void)
 
virtual bool __fastcall ProcessParams (const unsigned int argv, const tchar *const *const argc, tostream &o)
 
const shared_ptr< Logger< exception >, exception > &__fastcall Log (void) const noexcept(true)
 

Protected Member Functions

virtual bool __fastcall ProcessParamInternal (const unsigned int argv, const tchar *const *const argc, unsigned long &i, tostream &o)
 
virtual void __fastcall DumpHelp (tostream &o) const
 
- Protected Member Functions inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineParamsData
__stdcall CmdLineParamsData ()
 
 CmdLineParamsData (CmdLineParamsData const &)=delete
 
__stdcall ~CmdLineParamsData ()
 

Additional Inherited Members

- Protected Attributes inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineProcessorBase< ProgOpts, Except_ >
ProgramOptionsprog_opts
 
const tcharapp_name
 
- Protected Attributes inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineParamsData
const ParamType help_param
 
const ParamType version_param
 
- Static Protected Attributes inherited from jmmcg::LIBJMMCG_VER_NAMESPACE::CmdLineParamsData
static const ParamType params []
 
static const tchar *const authors []
 
static const tchar version [] =_T("0.1")
 
static const tchar copyright [] =_T("2003. This is free software; see the source for copying conditions.")
 
static const tchar warranty [] =_T("There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.")
 
static const tchar contact_details [] =_T("http://www.hussar.me.uk")
 
static const tchar help_text [] =_T("My test app.")
 

Detailed Description

template<typename ProgOpts, class Except_>
class jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >

A specialization for helping to making use of configuration files.

Definition at line 140 of file cmd_line_processing.hpp.

Member Typedef Documentation

◆ exception_t

template<typename ProgOpts , class Except_ >
typedef CmdLineProcessorBase<ProgOpts,Except_>::exception jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >::exception_t

Definition at line 143 of file cmd_line_processing.hpp.

◆ ProgramOptions

template<typename ProgOpts , class Except_ >
typedef CmdLineProcessorBase<ProgOpts,Except_>::ProgramOptions jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >::ProgramOptions

Definition at line 142 of file cmd_line_processing.hpp.

Constructor & Destructor Documentation

◆ ConfigFile() [1/2]

template<typename ProgOpts , class Except_ >
ConfigFile::ConfigFile ( ProgramOptions p)
inlineexplicit

◆ ConfigFile() [2/2]

template<typename ProgOpts , class Except_ >
jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >::ConfigFile ( ConfigFile< ProgOpts, Except_ > const &  )
delete

◆ ~ConfigFile()

template<typename ProgOpts , class Except_ >
virtual __stdcall jmmcg::LIBJMMCG_VER_NAMESPACE::ConfigFile< ProgOpts, Except_ >::~ConfigFile ( )
inlinevirtual

Definition at line 147 of file cmd_line_processing.hpp.

Member Function Documentation

◆ DumpHelp()

◆ ProcessParamInternal()

template<typename ProgOpts , class Except_ >
bool ConfigFile::ProcessParamInternal ( const unsigned int  argv,
const tchar *const *const  argc,
unsigned long &  i,
tostream o 
)
inlineprotectedvirtual

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