ISimpleTableOutput.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2022 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ISimpleTableOutput.hh                                       (C) 2000-2022 */
/*                                                                           */
/* Interface pour simples services de sortie de tableaux de valeurs.         */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#ifndef ARCANE_ISIMPLETABLEOUTPUT_H
#define ARCANE_ISIMPLETABLEOUTPUT_H
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/ISimpleTableInternalMng.h"
#include "arcane/ISimpleTableWriterHelper.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ARCANE_CORE_EXPORT ISimpleTableOutput
{
 public:
  virtual ~ISimpleTableOutput() = default;
 
 public:
  virtual bool init() = 0;
  virtual bool init(const String& table_name) = 0;
  virtual bool init(const String& table_name, const String& directory_name) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual void clear() = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer addRow(const String& row_name) = 0;
  virtual Integer addRow(const String& row_name, ConstArrayView<Real> elements) = 0;
  virtual bool addRows(StringConstArrayView rows_names) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer addColumn(const String& column_name) = 0;
  virtual Integer addColumn(const String& column_name, ConstArrayView<Real> elements) = 0;
  virtual bool addColumns(StringConstArrayView columns_names) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool addElementInRow(Integer position, Real element) = 0;
  virtual bool addElementInRow(const String& row_name, Real element, bool create_if_not_exist = true) = 0;
  virtual bool addElementInSameRow(Real element) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool addElementsInRow(Integer position, ConstArrayView<Real> elements) = 0;
  virtual bool addElementsInRow(const String& row_name, ConstArrayView<Real> elements, bool create_if_not_exist = true) = 0;
  virtual bool addElementsInSameRow(ConstArrayView<Real> elements) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool addElementInColumn(Integer position, Real element) = 0;
  virtual bool addElementInColumn(const String& column_name, Real element, bool create_if_not_exist = true) = 0;
  virtual bool addElementInSameColumn(Real element) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool addElementsInColumn(Integer position, ConstArrayView<Real> elements) = 0;
  virtual bool addElementsInColumn(const String& column_name, ConstArrayView<Real> elements, bool create_if_not_exist = true) = 0;
  virtual bool addElementsInSameColumn(ConstArrayView<Real> elements) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool editElementUp(Real element, bool update_last_position = true) = 0;
  virtual bool editElementDown(Real element, bool update_last_position = true) = 0;
  virtual bool editElementLeft(Real element, bool update_last_position = true) = 0;
  virtual bool editElementRight(Real element, bool update_last_position = true) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Real elementUp(bool update_last_position = false) = 0;
  virtual Real elementDown(bool update_last_position = false) = 0;
  virtual Real elementLeft(bool update_last_position = false) = 0;
  virtual Real elementRight(bool update_last_position = false) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool editElement(Real element) = 0;
  virtual bool editElement(Integer position_x, Integer position_y, Real element) = 0;
  virtual bool editElement(const String& column_name, const String& row_name, Real element) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Real element() = 0;
  virtual Real element(Integer position_x, Integer position_y, bool update_last_position = false) = 0;
  virtual Real element(const String& column_name, const String& row_name, bool update_last_position = false) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual RealUniqueArray row(Integer position) = 0;
  virtual RealUniqueArray row(const String& row_name) = 0;
 
  virtual RealUniqueArray column(Integer position) = 0;
  virtual RealUniqueArray column(const String& column_name) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer rowSize(Integer position) = 0;
  virtual Integer rowSize(const String& row_name) = 0;
 
  virtual Integer columnSize(Integer position) = 0;
  virtual Integer columnSize(const String& column_name) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer rowPosition(const String& row_name) = 0;
  virtual Integer columnPosition(const String& column_name) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer numberOfRows() = 0;
  virtual Integer numberOfColumns() = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual String rowName(Integer position) = 0;
  virtual String columnName(Integer position) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual bool editRowName(Integer position, const String& new_name) = 0;
  virtual bool editRowName(const String& row_name, const String& new_name) = 0;
 
  virtual bool editColumnName(Integer position, const String& new_name) = 0;
  virtual bool editColumnName(const String& column_name, const String& new_name) = 0;
 
  virtual Integer addAverageColumn(const String& column_name) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
  virtual void print(Integer rank = 0) = 0;
 
  virtual bool writeFile(const Directory& root_directory, Integer rank) = 0;
 
  virtual bool writeFile(Integer rank = -1) = 0;
  virtual bool writeFile(const String& directory, Integer rank = -1) = 0;
 
  /*---------------------------------------------------------------------------*/
  /*---------------------------------------------------------------------------*/
 
  virtual Integer precision() = 0;
  virtual void setPrecision(Integer precision) = 0;
 
  virtual bool isFixed() = 0;
  virtual void setFixed(bool fixed) = 0;
 
  virtual bool isForcedToUseScientificNotation() = 0;
  virtual void setForcedToUseScientificNotation(bool use_scientific) = 0;
 
  virtual String outputDirectory() = 0;
  virtual void setOutputDirectory(const String& directory) = 0;
 
  virtual String tableName() = 0;
  virtual void setTableName(const String& name) = 0;
 
  virtual String fileName() = 0;
 
  virtual Directory outputPath() = 0;
 
  virtual Directory rootPath() = 0;
 
  virtual bool isOneFileByRanksPermited() = 0;
 
  virtual String fileType() = 0;
 
  virtual Ref<SimpleTableInternal> internal() = 0;
 
  virtual Ref<ISimpleTableReaderWriter> readerWriter() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/