Properties.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* Properties.h                                                (C) 2000-2025 */
/*                                                                           */
/* List of properties.                                                       */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_PROPERTIES_H
#define ARCANE_CORE_PROPERTIES_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/UtilsTypes.h"
#include "arcane/utils/AutoRef.h"
#include "arcane/core/SharedReference.h"
#include "arcane/core/ArcaneTypes.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class PropertiesImpl;
class IPropertyMng;
 
class PropertiesImplBase
: public SharedReference
{
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT Properties
{
 public:

  Properties(IPropertyMng* pm, const String& name);

  Properties(const Properties& parent_property, const String& name);

  Properties(const Properties& rhs);
  const Properties& operator=(const Properties& rhs);
  virtual ~Properties();
 
 public:

  void setBool(const String& name, bool value);

  void set(const String& name, bool value);

  bool getBool(const String& name) const;

  bool getBoolWithDefault(const String& name, bool default_value) const;

  bool get(const String& name, bool& value) const;

  void setInt32(const String& name, Int32 value);

  void set(const String& name, Int32 value);

  Int32 getInt32(const String& name) const;

  Int32 getInt32WithDefault(const String& name, Int32 default_value) const;

  bool get(const String& name, Int32& value) const;

  void setInt64(const String& name, Int64 value);

  void set(const String& name, Int64 value);

  Int64 getInt64(const String& name) const;

  Int64 getInt64WithDefault(const String& name, Int64 default_value) const;

  bool get(const String& name, Int64& value) const;

  void setInteger(const String& name, Integer value);

  Integer getInteger(const String& name) const;

  Integer getIntegerWithDefault(const String& name, Integer default_value) const;

  void setReal(const String& name, Real value);

  void set(const String& name, Real value);

  Real getReal(const String& name) const;

  Real getRealWithDefault(const String& name, Real default_value) const;

  bool get(const String& name, Real& value) const;

  void setString(const String& name, const String& value);

  void set(const String& name, const String& value);

  String getString(const String& name) const;

  String getStringWithDefault(const String& name, const String& default_value) const;

  bool get(const String& name, String& value) const;

  void set(const String& name, BoolConstArrayView value);

  void get(const String& name, BoolArray& value) const;

  void set(const String& name, Int32ConstArrayView value);

  void get(const String& name, Int32Array& value) const;

  void set(const String& name, Int64ConstArrayView value);

  void get(const String& name, Int64Array& value) const;

  void set(const String& name, RealConstArrayView value);

  void get(const String& name, RealArray& value) const;

  void set(const String& name, StringConstArrayView value);

  void get(const String& name, StringArray& value) const;
 
 public:

  void print(std::ostream& o) const;

  void serialize(ISerializer* serializer);

  const String& name() const;

  const String& fullName() const;
 
  IPropertyMng* propertyMng() const;

  void destroy();

  PropertiesImpl* impl() const { return m_p; }

  PropertiesImplBase* baseImpl() const { return m_ref.get(); }
 
 private:
 
  PropertiesImpl* m_p;
  AutoRefT<PropertiesImplBase> m_ref;
 
 private:
 
  Properties(PropertiesImpl* p);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif