adtf::base::ant::cPropertiesBase Class Reference

#include <properties_v1.h>

Inherits adtf::ucom::catwo::object< IProperties >.

Inherited by adtf::base::ant::cProperties.

Public Member Functions
	cPropertiesBase ()
	dptr impl
virtual	~cPropertiesBase ()
	DTOR.
	cPropertiesBase (const cPropertiesBase &oPropy)
cPropertiesBase &	operator= (const cPropertiesBase &oPropy)
	cPropertiesBase (const IProperties &oIPropy)
cPropertiesBase &	operator= (const IProperties &oIPropy)
bool	Exists (const char *strName) const override
tResult	Get (IProperties &pProperties) const override
tResult	Set (const IProperties &pProperties) override
size_t	GetSize () const override
tResult	GetProperty (const char *strName, IProperty &pProperty) const override
tResult	SetProperty (const IProperty &pProperty) override
tResult	SetPropertyByPath (const char *strParentPath, const IProperty &pProperty) override
tResult	RemoveProperty (const char *strName) override
bool	IsEqual (const IProperties &oProperties) const
tResult	RegisterPropertyObserver (const char *strPropertyName, IPropertyObserver &oObserver)
tResult	UnregisterPropertyObserver (IPropertyObserver &oObserver)
cPropertiesBase &	CreateProperty (const char *strName, const ant::IPropertyValue &oValue)
Public Member Functions inherited from adtf::ucom::catwo::object< IProperties >
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
tResult	GetInterface (const char *i_strIID, void *&o_pInterface) override
	Query interfaces on an object.
tResult	GetInterface (const char *i_strIID, const void *&o_pInterface) const override
	Provides const correct interface querying.
void	Destroy () const override
	Switch from non-virtual destructor to virtual destructor.
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Base class for basic implementation of a IProperties interface.

It provides a basic implementation of a property storage which follows the definitons of IProperties.

Constructor & Destructor Documentation

cPropertiesBase() [1/3]

adtf::base::ant::cPropertiesBase::cPropertiesBase

(

)

dptr impl

CTOR

cPropertiesBase() [2/3]

adtf::base::ant::cPropertiesBase::cPropertiesBase

(

const cPropertiesBase &

oPropy

)

copy CTOR

Parameters

oPropy

[in] propertie to copy

cPropertiesBase() [3/3]

adtf::base::ant::cPropertiesBase::cPropertiesBase

(

const IProperties &

oIPropy

)

copy CTOR tfrom interface value

Parameters

oIPropy

[in] properties to copy

Member Function Documentation

CreateProperty()

cPropertiesBase & adtf::base::ant::cPropertiesBase::CreateProperty	(	const char *	strName,
		const ant::IPropertyValue &	oValue )

Adds a new property and returns a reference to the sub-properties object.

Use this for fast creation of property hierachies.

Parameters

[in]	strName	The name of the new property.
[in]	oValue	The value of the new property.

Returns

A reference to the sub properties of the newly created property.

IsEqual()

bool adtf::base::ant::cPropertiesBase::IsEqual

(

const IProperties &

oProperties

)

const

compares the content of the current storage with the given oProperties

Return values

true	Returns true if the same properties have the same value.
false	Returns false if same property has different value or type set.

operator=() [1/2]

cPropertiesBase & adtf::base::ant::cPropertiesBase::operator=

(

const cPropertiesBase &

oPropy

)

copy assignment

Parameters

oPropy

[in] propertie to copy

operator=() [2/2]

cPropertiesBase & adtf::base::ant::cPropertiesBase::operator=

(

const IProperties &

oIPropy

)

copy asignment

Parameters

oIPropy

[in] properties to copy

---

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

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