Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IPropertyValue Class Referenceabstract

Interface of a property value. More...

#include <arcane/core/IProperty.h>

Inheritance diagram for Arcane::IPropertyValue:
Collaboration diagram for Arcane::IPropertyValue:

Public Member Functions

virtual void valueToString (String &str) const =0
 Stores the property value in str.
virtual void nameToString (String &str) const =0
 Stores the property name in str.
virtual void setValueFromString (const String &str)=0
 Positions the new property value at str.
virtual bool isDefaultValue () const =0
 Returns whether the current value is the default value.
virtual bool isOriginalValue () const =0
 Returns whether the current value is the original value.
virtual void originalValueToString (String &str) const =0
 Stores the original property value in str.
virtual bool canBeEdited () const =0
 Returns whether the value can be edited.
virtual IPropertyTypetype ()=0
 Returns the type of this property.
virtual IPropertyTypeInstancetypeInstance ()=0
 Returns the instance associated with this value.

Additional Inherited Members

Public Types inherited from Arcane::Property
enum  ePropertyKind { PkSimple , PkEnum , PkExtended , PkComplex }
 Kind of a property. More...
enum  eSimpleType { StString , StReal , StInteger , StBool }
 Simple type in the case of a PkSimple kind. More...

Detailed Description

Interface of a property value.

Definition at line 72 of file IProperty.h.

Member Function Documentation

◆ canBeEdited()

virtual bool Arcane::IPropertyValue::canBeEdited ( ) const
pure virtual

Returns whether the value can be edited.

Implemented in Arcane::XmlPropertyValue.

◆ isDefaultValue()

virtual bool Arcane::IPropertyValue::isDefaultValue ( ) const
pure virtual

Returns whether the current value is the default value.

Implemented in Arcane::XmlPropertyValue.

◆ isOriginalValue()

virtual bool Arcane::IPropertyValue::isOriginalValue ( ) const
pure virtual

Returns whether the current value is the original value.

Implemented in Arcane::XmlPropertyValue.

◆ nameToString()

virtual void Arcane::IPropertyValue::nameToString ( String & str) const
pure virtual

Stores the property name in str.

Implemented in Arcane::XmlPropertyValue.

◆ originalValueToString()

virtual void Arcane::IPropertyValue::originalValueToString ( String & str) const
pure virtual

Stores the original property value in str.

Implemented in Arcane::XmlPropertyValue.

◆ setValueFromString()

virtual void Arcane::IPropertyValue::setValueFromString ( const String & str)
pure virtual

Positions the new property value at str.

Implemented in Arcane::XmlPropertyValue.

◆ type()

virtual IPropertyType * Arcane::IPropertyValue::type ( )
pure virtual

Returns the type of this property.

Implemented in Arcane::XmlPropertyValue.

◆ typeInstance()

virtual IPropertyTypeInstance * Arcane::IPropertyValue::typeInstance ( )
pure virtual

Returns the instance associated with this value.

Implemented in Arcane::XmlPropertyValue.

◆ valueToString()

virtual void Arcane::IPropertyValue::valueToString ( String & str) const
pure virtual

Stores the property value in str.

Implemented in Arcane::XmlPropertyValue.


The documentation for this class was generated from the following file: