MoochoPack::MoochoTrackerXMLSummary Class Reference

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
[legend]
List of all members.

Overridden from AlgorithmTracker

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

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.
void output_pre_file () const
 Output a basic file (with failed status).

Protected Member Functions

void open_problem_element (std::ostream &out, const Algorithm &algo) const
 Print the header to the output.
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_

Detailed Description

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

Definition at line 45 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 49 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

MoochoPack::MoochoTrackerXMLSummary::MoochoTrackerXMLSummary (  )  [private]


Member Function Documentation

void MoochoPack::MoochoTrackerXMLSummary::output_pre_file (  )  const

Output a basic file (with failed status).

Definition at line 240 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

void MoochoPack::MoochoTrackerXMLSummary::output_iteration ( const Algorithm algo  )  const [virtual]

Reimplemented from IterationPack::AlgorithmTracker.

Definition at line 64 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

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

Definition at line 95 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 292 of file MoochoPack_MoochoTrackerXMLSummary.cpp.

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

Definition at line 344 of file MoochoPack_MoochoTrackerXMLSummary.cpp.


Member Data Documentation

value_type MoochoPack::MoochoTrackerXMLSummary::obj_value_ [mutable, private]

Definition at line 87 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

value_type MoochoPack::MoochoTrackerXMLSummary::c_norm_value_ [mutable, private]

Definition at line 88 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::xml_filename_ [private]

Definition at line 90 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::problem_name_ [private]

Definition at line 91 of file MoochoPack_MoochoTrackerXMLSummary.hpp.

std::string MoochoPack::MoochoTrackerXMLSummary::algorithm_description_ [private]

Definition at line 92 of file MoochoPack_MoochoTrackerXMLSummary.hpp.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:57:26 2010 for MOOCHO (Single Doxygen Collection) by  doxygen 1.4.7