Teuchos - Trilinos Tools Package Version of the Day
Teuchos_TableFormat.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_TABLEFORMAT_H
00043 #define TEUCHOS_TABLEFORMAT_H
00044 
00049 #include "Teuchos_ConfigDefs.hpp"
00050 #include "Teuchos_TableColumn.hpp"
00051 #include <iostream>
00052 
00053 namespace Teuchos
00054 {
00055 
00065 class TableFormat
00066 {
00067 public:
00069   TableFormat()
00070     : pageWidth_(80), precision_(4), columnSpacing_(4),
00071       maxNameSize_(40), columnWidths_(), lineInterval_(10)
00072     {}
00073     
00076   int pageWidth() const {return pageWidth_;}
00077     
00080   int precision() const {return precision_;}
00081 
00084   int columnSpacing() const {return columnSpacing_;}
00085 
00089   void setPageWidth(int pw) const {pageWidth_ = pw;}
00090 
00092   void setPrecision(int p) {precision_ = p;}
00093 
00095   void setColumnSpacing(int columnSpacing_in) {columnSpacing_ = columnSpacing_in;}
00096 
00102   void setRowsBetweenLines(int lineInterval) {lineInterval_=lineInterval;}
00103 
00110   std::string thinline() const ;
00111 
00114   std::string thickline() const ;
00115 
00117   std::string blanks(int size) const ;
00118 
00127   int computeRequiredColumnWidth(const std::string& name,
00128     const TableColumn& column) const ;
00129 
00131   void setColumnWidths(const Array<int>& colWidths) 
00132     {columnWidths_ = colWidths;}
00133 
00140   void writeRow(
00141     std::ostream& out,
00142     const Array<RCP<TableEntry> >& entries
00143     ) const;
00144 
00152   void writeRow(
00153     std::ostream& out,
00154     int rowIndex,
00155     const Array<TableColumn>& columns
00156     ) const;
00157 
00159   void writeWholeTable(
00160     std::ostream& out,
00161     const std::string& tableTitle,
00162     const Array<std::string>& columnNames,
00163     const Array<TableColumn>& columns
00164     ) const ;
00165 
00166 protected:
00167 
00168   int defaultColumnWidth() const {return 20;}
00169 
00170 private:
00171 
00172   mutable int pageWidth_;
00173   int precision_;
00174   int columnSpacing_;
00175   int maxNameSize_;
00176   Array<int> columnWidths_;
00177   int lineInterval_;
00178 };
00179 
00180 
00181 } // namespace Teuchos
00182 
00183 
00184 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines