Teuchos_TableFormat.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//                    Teuchos: Common Tools Package
//
// Copyright 2004 NTESS and the Teuchos contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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),
    lineInterval_ (10),
    columnWidths_ ()
  {}

  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_; // UNUSED
  int lineInterval_;
  Array<int> columnWidths_;
};


} // namespace Teuchos


#endif