ADTF
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cPropertiesBase

Base class for basic implementation of a IProperties interface. More...

#include <properties_v1.h>

Inheritance diagram for cPropertiesBase:
[legend]

Public Member Functions

 cPropertiesBase ()
 CTOR.
 
virtual ~cPropertiesBase ()
 DTOR.
 
 cPropertiesBase (const cPropertiesBase &oPropy)
 copy CTOR
 
cPropertiesBaseoperator= (const cPropertiesBase &oPropy)
 copy assignment
 
 cPropertiesBase (const IProperties &oIPropy)
 copy CTOR tfrom interface value
 
cPropertiesBaseoperator= (const IProperties &oIPropy)
 copy asignment
 
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
 compares the content of the current storage with the given oProperties
 
tResult RegisterPropertyObserver (const char *strPropertyName, IPropertyObserver &oObserver)
 
tResult UnregisterPropertyObserver (IPropertyObserver &oObserver)
 
cPropertiesBaseCreateProperty (const char *strName, const ant::IPropertyValue &oValue)
 Adds a new property and returns a reference to the sub-properties object.
 
- Public Member Functions inherited from 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 IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast()
 

Private Member Functions

 A_UTILS_D (cPropertiesBase)
 dptr impl
 
 cPropertiesBase (cPropertiesBase &&oPropy)=delete
 no move
 
cPropertiesBaseoperator= (cPropertiesBase &&oPropy)=delete
 no move
 

Additional Inherited Members

- Protected Member Functions inherited from 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.

Definition at line 26 of file properties_v1.h.

Constructor & Destructor Documentation

◆ cPropertiesBase() [1/2]

cPropertiesBase ( const cPropertiesBase & oPropy)

copy CTOR

Parameters
oPropy[in] propertie to copy

References cPropertiesBase().

◆ cPropertiesBase() [2/2]

cPropertiesBase ( const IProperties & oIPropy)

copy CTOR tfrom interface value

Parameters
oIPropy[in] properties to copy

Member Function Documentation

◆ CreateProperty()

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]strNameThe name of the new property.
[in]oValueThe value of the new property.
Returns
A reference to the sub properties of the newly created property.

References cPropertiesBase().

◆ IsEqual()

bool IsEqual ( const IProperties & oProperties) const

compares the content of the current storage with the given oProperties

Return values
trueReturns true if the same properties have the same value.
falseReturns false if same property has different value or type set.

◆ operator=() [1/2]

cPropertiesBase & operator= ( const cPropertiesBase & oPropy)

copy assignment

Parameters
oPropy[in] propertie to copy

References cPropertiesBase().

◆ operator=() [2/2]

cPropertiesBase & operator= ( const IProperties & oIPropy)

copy asignment

Parameters
oIPropy[in] properties to copy

References cPropertiesBase().