oomph::CommandLineArgs::ArgInfo< T > Struct Template Reference

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

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

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

Detailed Description

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

Structure to store information on a command line argument.

Definition at line 633 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

Proper constructor.

Definition at line 636 of file oomph_utilities.h.

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

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 645 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 666 of file oomph_utilities.h.

Referenced by oomph::CommandLineArgs::ArgInfo< T >::ArgInfo(), and 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 669 of file oomph_utilities.h.

Referenced by oomph::CommandLineArgs::ArgInfo< T >::ArgInfo(), and 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 663 of file oomph_utilities.h.

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

---

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

• oomph_utilities.h