MOOCHO (Single Doxygen Collection): MoochoPack::MoochoTrackerXMLSummary Class Reference

MOOCHO (Single Doxygen Collection) Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages

This class outputs an XML summary file of the algorithm results and performance. More...

#include <MoochoPack_MoochoTrackerXMLSummary.hpp>

Inheritance diagram for MoochoPack::MoochoTrackerXMLSummary:

Inheritance graph

Public Member Functions
	MoochoTrackerXMLSummary (const Teuchos::RCP< std::ostream > &journal_out, const std::string xml_filename, const std::string problem_name, const std::string algorithm_description)
	Construct with an output stream. More...

void	output_pre_file () const
	Set the output stream for summary outputting. More...

Public Member Functions inherited from IterationPack::AlgorithmTracker
virtual	~AlgorithmTracker ()

	AlgorithmTracker (const ostream_ptr_t &journal_out)
	Construct with an output stream for journal_out. More...

virtual void	initialize ()
	Reinitialize the track object right before it is used. More...

virtual void	output_final (const Algorithm &algo, EAlgoReturn algo_return) const
	Output information about a just completed algorithm. More...

virtual void	set_journal_out (const ostream_ptr_t &journal_out)
	Set a smart pointer to the journal file. More...

const ostream_ptr_t &	get_journal_out () const
	Get the smart pointer to the journal file. More...

virtual std::ostream &	journal_out () const
	Return a reference to a `std::ostream` to be used to output debug information and the like. More...

Protected Member Functions
void	open_problem_element (std::ostream &out, const Algorithm &algo) const
	Print the header to the output. More...

void	close_problem_element (std::ostream &out) const

Private Member Functions
	MoochoTrackerXMLSummary ()

Private Attributes
value_type	obj_value_

value_type	c_norm_value_

std::string	xml_filename_

std::string	problem_name_

std::string	algorithm_description_

Overridden from AlgorithmTracker
void	output_iteration (const Algorithm &algo) const

void	output_final (const Algorithm &algo, EAlgoReturn algo_return) const

Detailed Description

This class outputs an XML summary file of the algorithm results and performance.

Definition at line 58 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

Constructor & Destructor Documentation

MoochoPack::MoochoTrackerXMLSummary::MoochoTrackerXMLSummary	(	const Teuchos::RCP< std::ostream > &	journal_out,
		const std::string	xml_filename,
		const std::string	problem_name,
		const std::string	algorithm_description
	)

Construct with an output stream.

Definition at line 62 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

MoochoPack::MoochoTrackerXMLSummary::MoochoTrackerXMLSummary ( )

private

Member Function Documentation

void MoochoPack::MoochoTrackerXMLSummary::output_pre_file ( ) const

Set the output stream for summary outputting.

Get the output stream for summary outputting. Output a basic file (with failed status)

Definition at line 253 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::output_iteration ( const Algorithm & algo ) const

virtual

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 77 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::output_final	(	const Algorithm &	algo,
		EAlgoReturn	algo_return
	)		const

Definition at line 108 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::open_problem_element	(	std::ostream &	out,
		const Algorithm &	algo
	)		const

protected

Print the header to the output.

Definition at line 305 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::close_problem_element ( std::ostream & out ) const

protected

Definition at line 357 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

Member Data Documentation

value_type MoochoPack::MoochoTrackerXMLSummary::obj_value_

mutableprivate

Definition at line 100 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

value_type MoochoPack::MoochoTrackerXMLSummary::c_norm_value_

mutableprivate

Definition at line 101 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::xml_filename_

private

Definition at line 103 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::problem_name_

private

Definition at line 104 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::algorithm_description_

private

Definition at line 105 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

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