IPropertyValue

The IPropertyValue interface provides methods for getting and setting property values. More...

#include <property_intf.h>

Inheritance diagram for IPropertyValue:

Public Member Functions
virtual tResult	GetType (IString &&strType) const =0
	Retrieves the string for the property value type.
virtual tResult	Set (const IPropertyValue &oValue)=0
	Sets the value by a deep copy.
virtual tResult	FromString (const IString &strValueAsString)=0
	Implement to deserialize the value from a textfile and/or to set by string.
virtual tResult	ToString (IString &&strIToString) const =0
	Implement to serialize the value to a textfile and/or to show it on a display.
Public Member Functions inherited from IRawValue
virtual tResult	FromRaw (const IRawMemory &oRawValue)=0
	Implement to create a fast value copy in memory.
virtual tResult	ToRaw (IRawMemory &&oRawValue) const =0
	Implement to create a fast value copy in memory.

Additional Inherited Members
Protected Member Functions inherited from IRawValue
virtual	~IRawValue ()=default
	protected DTOR

Detailed Description

The IPropertyValue interface provides methods for getting and setting property values.

Remarks

Since ADTF supports User Defined properties property operation are always COPY operations!

Definition at line 60 of file property_intf.h.

Member Function Documentation

FromString()

virtual tResult FromString ( const IString & strValueAsString )

pure virtual

Implement to deserialize the value from a textfile and/or to set by string.

Parameters

strValueAsString

[in] String to deserialize from

Return values

ERR_NOERROR	Successfully set to strType.
any_error	Depends on the implementation.

Implemented in property_value< T >, property_value< property_type >, property_value< property_type >, property_value< property_type >, cPropertyValue, property_value< T >, and cPropertyValue.

GetType()

virtual tResult GetType ( IString && strType ) const

pure virtual

Retrieves the string for the property value type.

Usually this is defined by the property_type_definition::TYPE_NAME.

Parameters

strType

[out] The type name.

See also

property_type_definition

Return values

ERR_NOERROR

Successfully set to strType.

Implemented in property_value< T >, property_value< property_type >, property_value< property_type >, property_value< property_type >, property_variable< T >, cPropertyValue, property_value< T >, and cPropertyValue.

Referenced by property_value< T >::Set().

Set()

virtual tResult Set ( const IPropertyValue & oValue )

pure virtual

Sets the value by a deep copy.

Parameters

oValue

[in] Value to set.

Return values

ERR_NOERROR	Successfully set to strType.
any_error	Depends on the implementation. I.e. ERR_INVALID_TYPE if IPropertyValue::GetType is different and no conversion implemented.

Implemented in property_value< T >, property_value< property_type >, property_value< property_type >, property_value< property_type >, cPropertyValue, property_value< T >, and cPropertyValue.

ToString()

virtual tResult ToString ( IString && strIToString ) const

pure virtual

Implement to serialize the value to a textfile and/or to show it on a display.

Parameters

strIToString

[out] serialized string value (should be human readable for displays!!)

Return values

ERR_NOERROR	Successfully set to strType.
any_error	Depends on the implementation.

Implemented in property_value< T >, property_value< property_type >, property_value< property_type >, property_value< property_type >, cPropertyValue, property_value< T >, and cPropertyValue.

Referenced by property_value< T >::Set().