Public Member Functions | Public Attributes | List of all members
oomph::CommandLineArgs::ArgInfo< T > Struct Template Reference

Structure to store information on a command line argument. More...

#include <oomph_utilities.h>

Public Member Functions

 ArgInfo (const bool &is_set, T *arg_pt, const std::string &doc)
 Proper constructor. More...
 
 ArgInfo ()
 Default constructor. We need this to be able to store these things in maps. More...
 

Public Attributes

bool is_set
 Has this argument been set? More...
 
T * arg_pt
 The place to put the argument's value when it is set. More...
 
std::string doc
 Information about what the argument does. More...
 

Detailed Description

template<class T>
struct oomph::CommandLineArgs::ArgInfo< T >

Structure to store information on a command line argument.

Definition at line 623 of file oomph_utilities.h.

Constructor & Destructor Documentation

◆ ArgInfo() [1/2]

template<class T >
oomph::CommandLineArgs::ArgInfo< T >::ArgInfo ( const bool &  is_set,
T *  arg_pt,
const std::string &  doc 
)
inline

◆ ArgInfo() [2/2]

template<class T >
oomph::CommandLineArgs::ArgInfo< T >::ArgInfo ( )
inline

Default constructor. We need this to be able to store these things in maps.

Definition at line 635 of file oomph_utilities.h.

References oomph::CommandLineArgs::ArgInfo< T >::arg_pt, oomph::CommandLineArgs::ArgInfo< T >::doc, and oomph::CommandLineArgs::ArgInfo< T >::is_set.

Member Data Documentation

◆ arg_pt

template<class T >
T* oomph::CommandLineArgs::ArgInfo< T >::arg_pt

The place to put the argument's value when it is set.

Definition at line 656 of file oomph_utilities.h.

Referenced by oomph::CommandLineArgs::ArgInfo< T >::ArgInfo().

◆ doc

template<class T >
std::string oomph::CommandLineArgs::ArgInfo< T >::doc

Information about what the argument does.

Definition at line 659 of file oomph_utilities.h.

Referenced by oomph::CommandLineArgs::ArgInfo< T >::ArgInfo().

◆ is_set

template<class T >
bool oomph::CommandLineArgs::ArgInfo< T >::is_set

Has this argument been set?

Definition at line 653 of file oomph_utilities.h.

Referenced by oomph::CommandLineArgs::ArgInfo< T >::ArgInfo().


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