TableLayout.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_FORMAT_TABLE_TABLELAYOUT_HPP
#define GEOS_COMMON_FORMAT_TABLE_TABLELAYOUT_HPP
 
#include "common/DataTypes.hpp"
 
namespace geos
{
 
class TableLayout
{
 
public:
 
  enum Alignment { right, left, center };
 
  enum MarginValue : integer
  {
    tiny = 0,
    small = 1,
    medium = 2,
    large = 3
  };
 
  enum Section { header, values };
 
  struct ColumnParam
  {
    string columnName;
    Alignment alignment = Alignment::right;
    bool enabled = true;
    std::vector< string > splitColumnNameLines;
 
    ColumnParam( std::string const & name, Alignment align )
      : columnName( name ), alignment( align )
    {}
 
    ColumnParam( std::string const & name, Alignment align, bool display )
      : columnName( name ), alignment( align ), enabled( display )
    {}
  };
 
  struct Column
  {
    ColumnParam m_parameter;
    std::vector< string > m_columnValues;
    string m_maxStringSize;
  };
 
  TableLayout() = default;
 
  TableLayout( std::vector< string > const & columnNames, string const & title = "" );
 
  TableLayout( std::vector< ColumnParam > const & columnParameters, string const & title = "" );
 
  std::vector< Column > const & getColumns() const;
 
  string_view getTitle() const;
 
  integer const & getBorderMargin() const;
 
  integer const & getColumnMargin() const;
 
  integer const & getMarginTitle() const;
 
  void setMargin( MarginValue marginValue );
 
private:
 
  std::vector< Column > m_columns;
  string m_tableTitle;
  integer m_borderMargin;
  integer m_columnMargin;
  integer m_titleMargin = 2;
 
};
}
 
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLELAYOUT_HPP */