Defintion of a property set container interface.
More...
#include <property_intf.h>
|
| 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.
|
|
virtual tResult | Get (IProperties &pProperties) const =0 |
| The Get method will copy the the content of current property store to the given pProperties.
|
|
virtual tResult | Set (const IProperties &pProperties)=0 |
| The Set method should copy the the content of pProperties to the property store of this.
|
|
virtual size_t | GetSize () const =0 |
| Return the current size (count of properties) within the store.
|
|
virtual tResult | GetProperty (const char *strName, IProperty &pProperty) const =0 |
| Find a property and set the content to the pProperty.
|
|
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 |
|
| ADTF_IID (IObject, "object.ant.ucom.adtf.iid") |
| Marks the IObject to be castable with the ucom_cast()
|
|
|
| ~IProperties ()=default |
| Protected destructor.
|
|
| ~IObject ()=default |
| Protected destructor --> Only the final implementation can be destroyed!
|
|
Defintion of a property set container interface.
The IProperties will provide an interface to access a container by a named based property storage.
Definition at line 212 of file property_intf.h.
◆ Exists()
virtual bool Exists |
( |
const char * | strName | ) |
const |
|
pure virtual |
Checks if property exists by name.
- Parameters
-
strName | [in] the name to check. |
◆ Get()
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_NOTFOUND | A property with the name strName does not exist. |
◆ 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()
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