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 ()

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.

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

Proper constructor.

      {
        this->is_set = is_set;
        this->arg_pt = arg_pt;
        this->doc = doc;
      }

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.

      {
        this->is_set = false;
        this->arg_pt = 0;
        this->doc = "";
      }

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.

doc

template<class T >

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

Information about what the argument does.

is_set

template<class T >

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

Has this argument been set?

---

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

• oomph_utilities.h