adtf::base::ant::IPropertyValue Class Reference

#include <property_intf.h>

Inherits adtf::base::ant::IRawValue.

Inherited by adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< T >, and adtf::base::spider::cPropertyValue.

Public Member Functions
virtual tResult	GetType (IString &&strType) const =0
virtual tResult	Set (const IPropertyValue &oValue)=0
virtual tResult	FromString (const IString &strValueAsString)=0
virtual tResult	ToString (IString &&strIToString) const =0
Public Member Functions inherited from adtf::base::ant::IRawValue
virtual tResult	FromRaw (const IRawMemory &oRawValue)=0
virtual tResult	ToRaw (IRawMemory &&oRawValue) const =0

Additional Inherited Members
Protected Member Functions inherited from adtf::base::ant::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!

Member Function Documentation

FromString()

virtual tResult adtf::base::ant::IPropertyValue::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 adtf::base::ant::property_value< T >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::cPropertyValue, adtf::base::property_value< T >, and adtf::base::spider::cPropertyValue.

GetType()

virtual tResult adtf::base::ant::IPropertyValue::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 adtf::base::ant::property_value< T >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_variable< T >, adtf::base::cPropertyValue, adtf::base::property_value< T >, and adtf::base::spider::cPropertyValue.

Set()

virtual tResult adtf::base::ant::IPropertyValue::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 adtf::base::ant::property_value< T >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::cPropertyValue, adtf::base::property_value< T >, and adtf::base::spider::cPropertyValue.

ToString()

virtual tResult adtf::base::ant::IPropertyValue::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 adtf::base::ant::property_value< T >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::ant::property_value< property_type >, adtf::base::cPropertyValue, adtf::base::property_value< T >, and adtf::base::spider::cPropertyValue.

---

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

• src/libraries/base/include/adtfbase/property_intf.h