IPostProcessorWriter.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IPostProcessorWriter.h                                      (C) 2000-2026 */
/*                                                                           */
/* Interface for a writer for post-processing information.                   */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IPOSTPROCESSORWRITER_H
#define ARCANE_CORE_IPOSTPROCESSORWRITER_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/core/ArcaneTypes.h"
#include "arcane/core/IService.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ICaseOptionList;
class IDataWriter;
class IMesh;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT IPostProcessorWriter
{
 public:

  virtual ~IPostProcessorWriter() = default;
 
 public:

  virtual void build() = 0;
 
 public:

  virtual IDataWriter* dataWriter() = 0;

  virtual void setBaseDirectoryName(const String& dirname) = 0;
 
  // TODO: Deprecate in 2027: use getBaseDirectoryName() instead
  virtual const String& baseDirectoryName() = 0;

  virtual String getBaseDirectoryName();

  virtual void setBaseFileName(const String& filename) = 0;
 
  // TODO: Deprecate in 2027: use getBaseFileName() instead
  virtual const String& baseFileName() = 0;

  virtual String getBaseFileName();

  ARCANE_DEPRECATED_REASON("Y2022: Choose the mesh during service creation via ServiceBuilder")
  virtual void setMesh(IMesh* mesh);

  virtual void setTimes(ConstArrayView<Real> times) = 0;

  virtual ConstArrayView<Real> times() = 0;

  virtual void setVariables(VariableCollection variables) = 0;

  virtual VariableCollection variables() = 0;

  virtual void setGroups(ItemGroupCollection groups) = 0;

  virtual ItemGroupCollection groups() = 0;
 
 public:

  virtual void notifyBeginWrite() = 0;

  virtual void notifyEndWrite() = 0;
 
 public:

  virtual void close() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif