Teuchos_TableFormat.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_TABLEFORMAT_H
#define TEUCHOS_TABLEFORMAT_H

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_TableColumn.hpp"
#include <iostream>

namespace Teuchos
{

class TableFormat
{
public:
  TableFormat()
    : pageWidth_(80), precision_(4), columnSpacing_(4),
      maxNameSize_(40), columnWidths_(), lineInterval_(10)
    {}
    
  int pageWidth() const {return pageWidth_;}
    
  int precision() const {return precision_;}

  int columnSpacing() const {return columnSpacing_;}

  void setPageWidth(int pw) const {pageWidth_ = pw;}

  void setPrecision(int p) {precision_ = p;}

  void setColumnSpacing(int columnSpacing_in) {columnSpacing_ = columnSpacing_in;}

  void setRowsBetweenLines(int lineInterval) {lineInterval_=lineInterval;}

  std::string thinline() const ;

  std::string thickline() const ;

  std::string blanks(int size) const ;

  int computeRequiredColumnWidth(const std::string& name,
    const TableColumn& column) const ;

  void setColumnWidths(const Array<int>& colWidths) 
    {columnWidths_ = colWidths;}

  void writeRow(
    std::ostream& out,
    const Array<RCP<TableEntry> >& entries
    ) const;

  void writeRow(
    std::ostream& out,
    int rowIndex,
    const Array<TableColumn>& columns
    ) const;

  void writeWholeTable(
    std::ostream& out,
    const std::string& tableTitle,
    const Array<std::string>& columnNames,
    const Array<TableColumn>& columns
    ) const ;

protected:

  int defaultColumnWidth() const {return 20;}

private:

  mutable int pageWidth_;
  int precision_;
  int columnSpacing_;
  int maxNameSize_;
  Array<int> columnWidths_;
  int lineInterval_;
};


} // namespace Teuchos


#endif