adtf::base::ant::IProperties Class Reference

#include <property_intf.h>

Inherits adtf::ucom::ant::IObject.

Public Member Functions
	ADTF_IID (IProperties, "properties.ant.base.adtf.iid")
	iid defintion for IProperties
virtual bool	Exists (const char *strName) const =0
virtual tResult	Get (IProperties &pProperties) const =0
virtual tResult	Set (const IProperties &pProperties)=0
virtual size_t	GetSize () const =0
virtual tResult	GetProperty (const char *strName, IProperty &pProperty) const =0
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 adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

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

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!

Member Function Documentation

Exists()

virtual bool adtf::base::ant::IProperties::Exists ( const char * strName ) const

pure virtual

Checks if property exists by name.

Parameters

strName

[in] the name to check.

Get()

virtual tResult adtf::base::ant::IProperties::Get ( IProperties & pProperties ) const

pure virtual

The Get method will copy 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 adtf::base::ant::IProperties::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 adtf::base::ant::IProperties::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 adtf::base::ant::IProperties::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

---

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

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