adtf::base::flash::cConfiguration Class Reference

#include <configuration.h>

Inherited by adtf::filter::cGraphObject.

Public Member Functions
	cConfiguration ()
	Default constructor.
virtual	~cConfiguration ()
	Destructor.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties)
tResult	AttachConfiguration (const char *strName, IConfiguration &oAttachedConfiguration)
tResult	DetachConfiguration (const char *strName)
tResult	RegisterPropertyVariable (const char *strName, ant::cPropertyVariable &oPropertyVariable)

Detailed Description

Implements all functionality required by ant::IConfiguration.

Member Function Documentation

AttachConfiguration()

tResult adtf::base::flash::cConfiguration::AttachConfiguration	(	const char *	strName,
		IConfiguration &	oAttachedConfiguration )

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

Parameters

[in]	strName	name of the tree item.
[in]	oAttachedConfiguration	configuration which properties are attached.

Returns

Standard Result Code

Deprecated

Attachments are deprecated, they suffer from issues with observers.

DetachConfiguration()

tResult adtf::base::flash::cConfiguration::DetachConfiguration

(

const char *

strName

)

Detaches a configuration with the specified name.

Parameters

[in]

strName

name of the tree item.

Returns

Standard Result Code

Return values

ERR_NOT_FOUND

The tree item with strName was not found.

Deprecated

Attachments are deprecated, they suffer from issues with observers.

GetProperties() [1/2]

tResult adtf::base::flash::cConfiguration::GetProperties

(

adtf::ucom::ant::iobject_ptr< const IProperties > &

pProperties

)

const

Gets the properties with read access.

Parameters

[in,out]

pProperties

object_ptr to the objects properties.

Returns

Standard Result Code

GetProperties() [2/2]

tResult adtf::base::flash::cConfiguration::GetProperties

(

adtf::ucom::ant::iobject_ptr< IProperties > &

pProperties

)

Gets the properties with read access.

Parameters

[in,out]

pProperties

object_ptr to the objects properties.

Returns

Standard Result Code

RegisterPropertyVariable()

tResult adtf::base::flash::cConfiguration::RegisterPropertyVariable	(	const char *	strName,
		ant::cPropertyVariable &	oPropertyVariable )

Registers a property variable that always reflects the current value of the property

Parameters

[in]	strName	Name of the property.
[in]	oPropertyVariable	The property variable instance.

Returns

Standard result.

---

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

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