cConfiguration

Implements all functionality required by ant::IConfiguration. More...

Inheritance diagram for cConfiguration:

Public Member Functions
	cConfiguration ()
	Default constructor.
virtual	~cConfiguration ()
	Destructor.
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< const IProperties > &pProperties) const
	Gets the properties with read access. More...
tResult	GetProperties (adtf::ucom::ant::iobject_ptr< IProperties > &pProperties)
	Gets the properties with read access. More...
tResult	AttachConfiguration (const char *strName, IConfiguration &oAttachedConfiguration)
	Attaches the given configuration and its properties as property tree item of this. More...
tResult	DetachConfiguration (const char *strName)
	Detaches a configuration with the specified name. More...
tResult	RegisterPropertyVariable (const char *strName, ant::cPropertyVariable &oPropertyVariable)
	Registers a property variable that always reflects the current value of the property. More...

Private Attributes
std::unique_ptr< cImplementation >	m_pImplementation

Detailed Description

Implements all functionality required by ant::IConfiguration.

Definition at line 368 of file configuration.h.

Member Function Documentation

AttachConfiguration()

tResult 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

DetachConfiguration()

tResult 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.

GetProperties() [1/2]

tResult 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 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 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.