oomph::MyDocInfo Class Reference

#include <my_problem.h>

Inheritance diagram for oomph::MyDocInfo:

Public Member Functions
	MyDocInfo ()
	Default constructor. More...
void	copy_args_string ()
	Copy dump of args into args_str. More...
Public Member Functions inherited from oomph::DocInfo
	DocInfo ()
	DocInfo (const std::string &directory)
	Constructor with specific directory. More...
std::string	directory () const
	Output directory. More...
void	set_directory (const std::string &directory)
void	enable_doc ()
	Enable documentation. More...
void	disable_doc ()
	Disable documentation. More...
bool	is_doc_enabled () const
	Are we documenting? More...
unsigned &	number ()
	Number used (e.g.) for labeling output files. More...
unsigned	number () const
	Number used (e.g.) for labeling output files. Const version. More...
std::string	number_as_string () const
	Get number as a string (useful to completely avoid C-strings). More...
std::string &	label ()
	String used (e.g.) for labeling output files. More...
std::string	label () const
	String used (e.g.) for labeling output files. Const version. More...
void	enable_error_if_directory_does_not_exist ()
	Call to throw an error if directory does not exist. More...
void	disable_error_if_directory_does_not_exist ()
	Call to issue a warning if the directory does not exists. More...

Public Attributes
std::string	output_jacobian
std::string	args_str

Constructor & Destructor Documentation

MyDocInfo()

oomph::MyDocInfo::MyDocInfo ( )

inline

Default constructor.

: DocInfo(), output_jacobian("never") {}

Member Function Documentation

copy_args_string()

void oomph::MyDocInfo::copy_args_string ( )

inline

Copy dump of args into args_str.

  {
   std::ostringstream stream;
   CommandLineArgs::doc_all_flags(stream);
   args_str.assign(stream.str());
  }

References oomph::CommandLineArgs::doc_all_flags().

Member Data Documentation

args_str

std::string oomph::MyDocInfo::args_str

output_jacobian

std::string oomph::MyDocInfo::output_jacobian

---

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

• my_problem.h