ICaseDocument.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2023 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ICaseDocument.h                                             (C) 2000-2023 */
/*                                                                           */
/* Interface d'une classe gérant un document XML du jeu de données.          */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_ICASEDOCUMENT_H
#define ARCANE_ICASEDOCUMENT_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/XmlNodeList.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class CaseNodeNames;
class XmlNode;
class IXmlDocumentHolder;
class CaseOptionError;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ICaseDocumentFragment
{
 public:
 
  virtual ~ICaseDocumentFragment() = default;
 
 public:
 
  virtual IXmlDocumentHolder* documentHolder() =0;
 
  virtual XmlNode documentNode() =0;
 
  virtual XmlNode rootElement() =0;
 
  virtual String language() const =0;
 
  virtual String defaultCategory() const =0;
 
  virtual CaseNodeNames* caseNodeNames() =0;
  
 public:
 
  virtual void addError(const CaseOptionError& case_error) =0;
 
  virtual void addWarning(const CaseOptionError& case_error) =0;
 
  // Indique si le jeu de données contient des erreurs.
  virtual bool hasError() const =0;
 
  // Indique si le jeu de données contient des avertissements.
  virtual bool hasWarnings() const =0;
 
  virtual void printErrors(std::ostream& o) =0;
 
  virtual void printWarnings(std::ostream& o) =0;
 
  virtual void clearErrorsAndWarnings() =0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ICaseDocument
: public ICaseDocumentFragment
{
 public:
 
  virtual void build() =0;
 
  virtual ICaseDocument* clone() =0;
 
 public:
 
  virtual CaseNodeNames* caseNodeNames() =0;
 
  virtual XmlNode arcaneElement() =0;
 
  virtual XmlNode configurationElement() =0;
 
  virtual XmlNode timeloopElement() =0;
  virtual XmlNode titleElement() =0;
  virtual XmlNode descriptionElement() =0;
  virtual XmlNode modulesElement() =0;
  virtual XmlNode servicesElement() =0;
 
  virtual XmlNode functionsElement() =0;
 
  virtual const XmlNodeList& meshElements() =0;
 
  virtual XmlNode meshesElement() =0;
 
  virtual String userClass() const =0;
  virtual void setUserClass(const String& value) =0;
 
  virtual String codeName() const =0;
  virtual void setCodeName(const String& value) =0;
 
  virtual String codeVersion() const =0;
  virtual void setCodeVersion(const String& value) =0;
 
  virtual String codeUnitSystem() const =0;
  virtual void setCodeUnitSystem(const String& value) =0;
 
  virtual void setDefaultCategory(const String& v) =0;
 
  virtual ICaseDocumentFragment* fragment() =0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif