adtf::base::property_value< T > Class Template Reference

#include <property.h>

Inherits adtf::base::ant::IPropertyValue.

Inherited by adtf::base::ant::property_variable< T > [private].

Public Member Functions
	property_value (const property_value &oValue)
	property_value (property_value &&oValue)
	property_value (const T &oValue)
property_value &	operator= (const property_value &oValue)
property_value &	operator= (property_value &&oValue)
const property_value &	operator= (const T &oValue)
void	Release ()
bool	operator== (const T &oValue) const
bool	operator== (const property_value &oValue) const
const T &	GetValue () const
tResult	Set (const IPropertyValue &oValue)
tResult	GetType (IString &&strType) const
tResult	ToRaw (IRawMemory &&oToMem) const
tResult	FromRaw (const IRawMemory &oFromMem)
tResult	ToString (IString &&oStringValue) const
tResult	FromString (const IString &oStringValue)

Protected Attributes
T	m_oValue

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

Detailed Description

template<typename T>
class adtf::base::property_value< T >

property_value template class that implements the IPropertyValue interface for a given type T.

Member Function Documentation

FromRaw()

template<typename T>

tResult adtf::base::ant::property_value< T >::FromRaw ( const IRawMemory & oRawValue )

inlinevirtual

Implement to create a fast value copy in memory. Usually this method is called if types are equal implementation is within the same binary!

Parameters

oRawValue

[in] Memory representation of the value

Return values

ERR_NOERROR	Successfully copied.
ERR_MEMORY	You have to return ERR_MEMORY if size of oRawValue does not fit !!
any_error	Depends on the implementation.

Implements adtf::base::ant::IRawValue.

FromString()

template<typename T>

tResult adtf::base::ant::property_value< T >::FromString ( const IString & strValueAsString )

inlinevirtual

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.

Implements adtf::base::ant::IPropertyValue.

GetType()

template<typename T>

tResult adtf::base::ant::property_value< T >::GetType ( IString && strType ) const

inlinevirtual

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.

Implements adtf::base::ant::IPropertyValue.

Set()

template<typename T>

tResult adtf::base::ant::property_value< T >::Set ( const IPropertyValue & oValue )

inlinevirtual

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.

Implements adtf::base::ant::IPropertyValue.

ToRaw()

template<typename T>

tResult adtf::base::ant::property_value< T >::ToRaw ( IRawMemory && oRawValue ) const

inlinevirtual

Implement to create a fast value copy in memory. Usually this method is called if types are equal implementation is within the same binary!

Parameters

oRawValue

[oRawValue] copy of the memory representation of the value

Return values

ERR_NOERROR	Successfully copied.
any_error	Depends on the implementation. You are adviced to return the return value of IRawMemory::Set.

Implements adtf::base::ant::IRawValue.

ToString()

template<typename T>

tResult adtf::base::ant::property_value< T >::ToString ( IString && strIToString ) const

inlinevirtual

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.

Implements adtf::base::ant::IPropertyValue.

---

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

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