MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_MoochoTrackerXMLSummary.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef MOOCHO_TRACKER_XML_SUMMARY_HPP
00043 #define MOOCHO_TRACKER_XML_SUMMARY_HPP
00044 
00045 #include "IterationPack_Algorithm.hpp"
00046 #include "IterationPack_AlgorithmTracker.hpp"
00047 #include "MoochoPack_Types.hpp"
00048 
00049 namespace MoochoPack {
00050 
00051 
00052 using IterationPack::Algorithm;
00053 using IterationPack::EAlgoReturn;
00054 
00058 class MoochoTrackerXMLSummary
00059   : public IterationPack::AlgorithmTracker
00060 {
00061 public:
00062 
00064   MoochoTrackerXMLSummary(
00065     const Teuchos::RCP<std::ostream> &journal_out
00066     ,const std::string xml_filename
00067     ,const std::string problem_name
00068     ,const std::string algorithm_description
00069     );
00070 
00072   //void set_output_stream(const ostream_ptr_t& o);
00073 
00075   //const ostream_ptr_t& get_output_stream() const;
00076 
00078   //   that will be overwritten if there is no
00079   //   exception
00080   void output_pre_file() const;
00081 
00084 
00086   void output_iteration(const Algorithm& algo) const;
00088   void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
00089   
00091 
00092 protected:
00093 
00095   void open_problem_element( std::ostream& out, const Algorithm& algo) const;
00096   void close_problem_element( std::ostream& out) const;
00097 
00098 private:
00099 
00100   mutable value_type obj_value_;
00101   mutable value_type c_norm_value_;
00102 
00103   std::string xml_filename_;
00104   std::string problem_name_;
00105   std::string algorithm_description_;
00106 
00107   // Not defined and not to be called
00108   MoochoTrackerXMLSummary();
00109 
00110 };  // end class MoochoTrackerXMLSummary
00111 
00112 } // end namespace MoochoPack 
00113 
00114 #endif  // RSQP_TRACK_SUMMARY_STD_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines