IProperty.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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IProperty.h                                                 (C) 2000-2025 */
/*                                                                           */
/* Property interface.                                                       */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_IPROPERTY_H
#define ARCANE_CORE_IPROPERTY_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArcaneGlobal.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IPropertyValue;
class IPropertyType;
class IPropertyTypeInstance;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class Property
{
 public:
 
  virtual ~Property() = default;
 
 public:

  enum ePropertyKind
  {
    PkSimple, 
    PkEnum, 
    PkExtended, 
    PkComplex 
  };

  enum eSimpleType
  {
    StString,
    StReal,
    StInteger,
    StBool
  };
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class IPropertyValue
: public Property
{
 public:

  virtual void valueToString(String& str) const = 0;
  virtual void nameToString(String& str) const = 0;
  virtual void setValueFromString(const String& str) = 0;
  virtual bool isDefaultValue() const = 0;
  virtual bool isOriginalValue() const = 0;
  virtual void originalValueToString(String& str) const = 0;
  virtual bool canBeEdited() const = 0;
  virtual IPropertyType* type() = 0;
  virtual IPropertyTypeInstance* typeInstance() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class IPropertyType
: public Property
{
 public:

  virtual void typeNameToString(String& str) const = 0;

  virtual ePropertyKind kind() const = 0;

  virtual Integer nbEnumeratedValue() const = 0;

  virtual String enumeratedValue(Integer i) const = 0;

  virtual eSimpleType simpleType() const = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class IPropertyTypeInstance
: public Property
{
 public:

  virtual void nameToString(String& str) const = 0;
  virtual IPropertyType* type() = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif