Arcane::XmlPropertyValue Class Reference

Interface of a property value. More...

#include <arcane/core/XmlProperty.h>

Inheritance diagram for Arcane::XmlPropertyValue:

Collaboration diagram for Arcane::XmlPropertyValue:

Public Member Functions
	XmlPropertyValue (const XmlNode &node, IPropertyType *type, IPropertyTypeInstance *type_instance)
void	valueToString (String &str) const override
	Stores the property value in str.
void	nameToString (String &str) const override
	Stores the property name in str.
void	setValueFromString (const String &str) override
	Positions the new property value at str.
bool	isDefaultValue () const override
	Returns whether the current value is the default value.
bool	isOriginalValue () const override
	Returns whether the current value is the original value.
void	originalValueToString (String &str) const override
	Stores the original property value in str.
bool	canBeEdited () const override
	Returns whether the value can be edited.
IPropertyType *	type () override
	Returns the type of this property.
IPropertyTypeInstance *	typeInstance () override
	Returns the instance associated with this value.
XmlNode &	node ()
void	setNode (const XmlNode &node)
void	setType (IPropertyType *type)
void	setTypeInstance (IPropertyTypeInstance *type_instance)

Private Attributes
XmlNode	m_node
IPropertyType *	m_type = nullptr
IPropertyTypeInstance *	m_type_instance = nullptr

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 32 of file XmlProperty.h.

Constructor & Destructor Documentation

XmlPropertyValue() [1/2]

Arcane::XmlPropertyValue::XmlPropertyValue	(	const XmlNode &	node,
		IPropertyType *	type,
		IPropertyTypeInstance *	type_instance )

Definition at line 27 of file XmlProperty.cc.

XmlPropertyValue() [2/2]

Arcane::XmlPropertyValue::XmlPropertyValue

(

)

Definition at line 36 of file XmlProperty.cc.

Member Function Documentation

canBeEdited()

bool Arcane::XmlPropertyValue::canBeEdited ( ) const

overridevirtual

Returns whether the value can be edited.

Implements Arcane::IPropertyValue.

Definition at line 80 of file XmlProperty.cc.

isDefaultValue()

bool Arcane::XmlPropertyValue::isDefaultValue ( ) const

overridevirtual

Returns whether the current value is the default value.

Implements Arcane::IPropertyValue.

Definition at line 62 of file XmlProperty.cc.

isOriginalValue()

bool Arcane::XmlPropertyValue::isOriginalValue ( ) const

overridevirtual

Returns whether the current value is the original value.

Implements Arcane::IPropertyValue.

Definition at line 68 of file XmlProperty.cc.

nameToString()

void Arcane::XmlPropertyValue::nameToString ( String & str ) const

overridevirtual

Stores the property name in str.

Implements Arcane::IPropertyValue.

Definition at line 50 of file XmlProperty.cc.

node()

XmlNode & Arcane::XmlPropertyValue::node

(

)

Definition at line 110 of file XmlProperty.cc.

originalValueToString()

void Arcane::XmlPropertyValue::originalValueToString ( String & str ) const

overridevirtual

Stores the original property value in str.

Implements Arcane::IPropertyValue.

Definition at line 74 of file XmlProperty.cc.

setNode()

void Arcane::XmlPropertyValue::setNode

(

const XmlNode &

node

)

Definition at line 116 of file XmlProperty.cc.

setType()

void Arcane::XmlPropertyValue::setType

(

IPropertyType *

type

)

Definition at line 98 of file XmlProperty.cc.

setTypeInstance()

void Arcane::XmlPropertyValue::setTypeInstance

(

IPropertyTypeInstance *

type_instance

)

Definition at line 104 of file XmlProperty.cc.

setValueFromString()

void Arcane::XmlPropertyValue::setValueFromString ( const String & str )

overridevirtual

Positions the new property value at str.

Implements Arcane::IPropertyValue.

Definition at line 56 of file XmlProperty.cc.

type()

IPropertyType * Arcane::XmlPropertyValue::type ( )

overridevirtual

Returns the type of this property.

Implements Arcane::IPropertyValue.

Definition at line 86 of file XmlProperty.cc.

typeInstance()

IPropertyTypeInstance * Arcane::XmlPropertyValue::typeInstance ( )

overridevirtual

Returns the instance associated with this value.

Implements Arcane::IPropertyValue.

Definition at line 92 of file XmlProperty.cc.

valueToString()

void Arcane::XmlPropertyValue::valueToString ( String & str ) const

overridevirtual

Stores the property value in str.

Implements Arcane::IPropertyValue.

Definition at line 44 of file XmlProperty.cc.

Member Data Documentation

m_node

XmlNode Arcane::XmlPropertyValue::m_node

private

Definition at line 62 of file XmlProperty.h.

m_type

IPropertyType* Arcane::XmlPropertyValue::m_type = nullptr

private

Definition at line 63 of file XmlProperty.h.

m_type_instance

IPropertyTypeInstance* Arcane::XmlPropertyValue::m_type_instance = nullptr

private

Definition at line 64 of file XmlProperty.h.

---

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

• XmlProperty.h
• XmlProperty.cc