ADTF  3.14.3
IPropertiesabstract

Defintion of a property set container interface. More...

Inheritance diagram for IProperties:
[legend]

Public Member Functions

 ADTF_IID (IProperties, "properties.ant.base.adtf.iid")
 iid defintion for IProperties
 
virtual bool Exists (const char *strName) const =0
 Checks if property exists by name. More...
 
virtual tResult Get (IProperties &pProperties) const =0
 The Get method will copy the the content of current property store to the given pProperties. More...
 
virtual tResult Set (const IProperties &pProperties)=0
 The Set method should copy the the content of pProperties to the property store of this. More...
 
virtual size_t GetSize () const =0
 Return the current size (count of properties) within the store. More...
 
virtual tResult GetProperty (const char *strName, IProperty &pProperty) const =0
 Find a property and set the content to the pProperty. More...
 
virtual tResult SetProperty (const IProperty &pProperty)=0
 
virtual tResult SetPropertyByPath (const char *strParentPath, const IProperty &pProperty)=0
 
virtual tResult RemoveProperty (const char *strName)=0
 
virtual tResult RegisterPropertyObserver (const char *strPropertyName, IPropertyObserver &oObserver)=0
 
virtual tResult UnregisterPropertyObserver (IPropertyObserver &oObserver)=0
 
- Public Member Functions inherited from IObject
 ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
 Marks the IObject to be castable with the ucom_cast() More...
 

Protected Member Functions

 ~IProperties ()=default
 Protected destructor.
 
- Protected Member Functions inherited from IObject
 ~IObject ()=default
 Protected destructor --> Use implemented Destroy() instead of delete!
 

Detailed Description

Defintion of a property set container interface.

The IProperties will provide an interface to access a container by a named based property storage.

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

Definition at line 172 of file property_intf.h.

Member Function Documentation

◆ Exists()

virtual bool Exists ( const char *  strName) const
pure virtual

Checks if property exists by name.

Parameters
strName[in] the name to check.

Referenced by adtf::base::ant::get_property().

◆ Get()

virtual tResult Get ( IProperties pProperties) const
pure virtual

The Get method will copy the the content of current property store to the given pProperties.

Usually this is a simple call of pProperties.Set(*this);

Parameters
pProperties[in] The Property set where to copy the content to.
Returns
Standard Result

◆ GetProperty()

virtual tResult GetProperty ( const char *  strName,
IProperty pProperty 
) const
pure virtual

Find a property and set the content to the pProperty.

This method will always COPY.

Parameters
strName[in] Name of the property to find
pProperty[in, out] Property interface to set the content to.
Return values
ERR_NOTFOUNDA property with the name strName does not exist.

Referenced by adtf::base::ant::get_property().

◆ GetSize()

virtual size_t GetSize ( ) const
pure virtual

Return the current size (count of properties) within the store.

Any subproperties are NOT counted.

Returns
The count of properties.

◆ Set()

virtual tResult Set ( const IProperties pProperties)
pure virtual

The Set method should copy the the content of pProperties to the property store of this.

Parameters
pProperties[in] The Property set where to copy the content from.
Returns
Standard Result

Copyright © Audi Electronics Venture GmbH. All rights reserved. (Generated on Thu Jun 9 2022 by doxygen 1.9.1)