ADTF
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
adtf::base::IConfiguration Class Referenceabstract

#include <configuration_intf.h>

Public Member Functions

 ADTF_IID (IConfiguration, "configuration.ant.base.adtf.iid")
 defintion of interace id
 
virtual tResult GetProperties (ucom::ant::iobject_ptr< const IProperties > &pProperties) const=0
 
virtual tResult GetProperties (ucom::ant::iobject_ptr< IProperties > &pProperties)=0
 
virtual tResult AttachConfiguration (const char *strName, IConfiguration &oAttachedConfiguration)=0
 
virtual tResult DetachConfiguration (const char *strName)=0
 

Protected Member Functions

virtual ~IConfiguration ()=default
 not destructable
 

Detailed Description

ucom Interface to a objects configuration.

Remarks
: This is no object interface !

Member Function Documentation

◆ AttachConfiguration()

virtual tResult adtf::base::ant::IConfiguration::AttachConfiguration ( const char * strName,
IConfiguration & oAttachedConfiguration )
pure virtual

Attaches the given configuration and its properties as property tree item of this.

Parameters
[in]strNamename of the tree item.
[in]oAttachedConfigurationconfiguration which properties are attached.
Returns
Standard Result Code
Deprecated
Attachments are deprecated, they suffer from issues with observers.

◆ DetachConfiguration()

virtual tResult adtf::base::ant::IConfiguration::DetachConfiguration ( const char * strName)
pure virtual

Detaches a configuration with the specified name.

Parameters
[in]strNamename of the tree item.
Returns
Standard Result Code
Return values
ERR_NOT_FOUNDThe tree item with strName was not found.
Deprecated
Attachments are deprecated, they suffer from issues with observers.

◆ GetProperties() [1/2]

virtual tResult adtf::base::ant::IConfiguration::GetProperties ( ucom::ant::iobject_ptr< const IProperties > & pProperties) const
pure virtual

Gets the properties with read access.

Parameters
[in,out]pPropertiesobject_ptr to the objects properties.
Returns
Standard Result Code

◆ GetProperties() [2/2]

virtual tResult adtf::base::ant::IConfiguration::GetProperties ( ucom::ant::iobject_ptr< IProperties > & pProperties)
pure virtual

Gets the properties with read/write access.

Parameters
[in,out]pPropertiesobject_ptr to to the objects properties.
Returns
Standard Result Code
The documentation for this class was generated from the following file: